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.58 by root, Sun Jan 8 22:58:13 2006 UTC vs.
Revision 1.87 by root, Thu Jan 12 05:37:34 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 and further clicks). Right
46urls and complete shell-quoted arguments, which is very convenient, too, 46now, it tries to select words, urls and complete shell-quoted
47if your F<ls> supports C<--quoting-style=shell>. 47arguments, which is very convenient, too, if your F<ls> supports
48C<--quoting-style=shell>.
48 49
50A double-click usually selects the word under the cursor, further clicks
51will enlarge the selection.
52
49It also offers the following bindable event: 53It also offers the following bindable keyboard command:
50 54
51=over 4 55=over 4
52 56
53=item rot13 57=item rot13
54 58
58 62
59=back 63=back
60 64
61=item option-popup (enabled by default) 65=item option-popup (enabled by default)
62 66
63Binds a popup menu to Ctrl-Button3 that lets you toggle (some) options at 67Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
64runtime. 68runtime.
65 69
70=item selection-popup (enabled by default)
71
72Binds a popup menu to Ctrl-Button3 that lets you convert the selection
73text into various other formats/action (such as uri unescaping, perl
74evalution, web-browser starting etc.), depending on content.
75
76=item searchable-scrollback<hotkey> (enabled by default)
77
78Adds regex search functionality to the scrollback buffer, triggered
79by a hotkey (default: C<M-s>). While in search mode, normal terminal
80input/output is suspended and a regex is displayed at the bottom of the
81screen.
82
83Inputting characters appends them to the regex and continues incremental
84search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
85search upwards/downwards in the scrollback buffer, C<End> jumps to the
86bottom. C<Escape> leaves search mode and returns to the point where search
87was started, while C<Enter> or C<Return> stay at the current position and
88additionally stores the first match in the current line into the primary
89selection.
90
66=item digital-clock 91=item digital-clock
67 92
68Displays a digital clock using the built-in overlay. 93Displays a digital clock using the built-in overlay.
69 94
70=item mark-urls 95=item mark-urls
71 96
72Uses per-line display filtering (C<on_line_update>) to underline urls. 97Uses per-line display filtering (C<on_line_update>) to underline urls and
98make them clickable. When middle-clicked, the program specified in the
99resource C<urlLauncher> (default C<x-www-browser>) will be started with
100the URL as first argument.
73 101
74=item block-graphics-to-ascii 102=item block-graphics-to-ascii
75 103
76A not very useful example of filtering all text output to the terminal, 104A not very useful example of filtering all text output to the terminal,
77by replacing all line-drawing characters (U+2500 .. U+259F) by a 105by replacing all line-drawing characters (U+2500 .. U+259F) by a
82Displays a very simple digital clock in the upper right corner of the 110Displays a very simple digital clock in the upper right corner of the
83window. Illustrates overwriting the refresh callbacks to create your own 111window. Illustrates overwriting the refresh callbacks to create your own
84overlays or changes. 112overlays or changes.
85 113
86=back 114=back
115
116=head1 API DOCUMENTATION
87 117
88=head2 General API Considerations 118=head2 General API Considerations
89 119
90All objects (such as terminals, time watchers etc.) are typical 120All objects (such as terminals, time watchers etc.) are typical
91reference-to-hash objects. The hash can be used to store anything you 121reference-to-hash objects. The hash can be used to store anything you
104=over 4 134=over 4
105 135
106=item $text 136=item $text
107 137
108Rxvt-unicodes special way of encoding text, where one "unicode" character 138Rxvt-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. 139always represents one screen cell. See L<ROW_t> for a discussion of this format.
110 140
111=item $string 141=item $string
112 142
113A perl text string, with an emphasis on I<text>. It can store all unicode 143A 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 144characters and is to be distinguished with text encoded in a specific
119Either binary data or - more common - a text string encoded in a 149Either binary data or - more common - a text string encoded in a
120locale-specific way. 150locale-specific way.
121 151
122=back 152=back
123 153
154=head2 Extension Objects
155
156Very perl extension is a perl class. A separate perl object is created
157for each terminal and each extension and passed as the first parameter to
158hooks. So extensions can use their C<$self> object without having to think
159about other extensions, with the exception of methods and members that
160begin with an underscore character C<_>: these are reserved for internal
161use.
162
163Although it isn't a C<urxvt::term> object, you can call all methods of the
164C<urxvt::term> class on this object.
165
166It has the following methods and data members:
167
168=over 4
169
170=item $urxvt_term = $self->{term}
171
172Returns the C<urxvt::term> object associated with this instance of the
173extension. This member I<must not> be changed in any way.
174
175=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
176
177Dynamically enable the given hooks (named without the C<on_> prefix) for
178this extension, replacing any previous hook. This is useful when you want
179to overwrite time-critical hooks only temporarily.
180
181=item $self->disable ($hook_name[, $hook_name..])
182
183Dynamically disable the given hooks.
184
185=back
186
124=head2 Hooks 187=head2 Hooks
125 188
126The following subroutines can be declared in extension files, and will be 189The following subroutines can be declared in extension files, and will be
127called whenever the relevant event happens. 190called whenever the relevant event happens.
128 191
129The first argument passed to them is an object private to each terminal 192The 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 193the 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 194
136All of them must return a boolean value. If it is true, then the event 195B<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, 196event 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. 197skipped, and the relevant action might not be carried out by the C++ code.
139 198
140When in doubt, return a false value (preferably C<()>). 199I<< When in doubt, return a false value (preferably C<()>). >>
141 200
142=over 4 201=over 4
143 202
144=item on_init $term 203=item on_init $term
145 204
180=item on_sel_extend $term 239=item on_sel_extend $term
181 240
182Called whenever the user tries to extend the selection (e.g. with a double 241Called whenever the user tries to extend the selection (e.g. with a double
183click) and is either supposed to return false (normal operation), or 242click) and is either supposed to return false (normal operation), or
184should extend the selection itelf and return true to suppress the built-in 243should extend the selection itelf and return true to suppress the built-in
185processing. 244processing. This can happen multiple times, as long as the callback
245returns true, it will be called on every further click by the user and is
246supposed to enlarge the selection more and more, if possible.
186 247
187See the F<selection> example extension. 248See the F<selection> example extension.
188 249
189=item on_view_change $term, $offset 250=item on_view_change $term, $offset
190 251
199than the scroll back buffer or the terminal. 260than the scroll back buffer or the terminal.
200 261
201It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 262It 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 263$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
203number of lines that will be in the scrollback buffer. 264number 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 265
209=item on_osc_seq $term, $string 266=item on_osc_seq $term, $string
210 267
211Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 268Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
212operating system command) is processed. Cursor position and other state 269operating system command) is processed. Cursor position and other state
225can filter/change and output the text yourself by returning a true value 282can filter/change and output the text yourself by returning a true value
226and calling C<< $term->scr_add_lines >> yourself. Please note that this 283and 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 284might be very slow, however, as your hook is called for B<all> text being
228output. 285output.
229 286
287=item on_tt_write $term, $octets
288
289Called whenever some data is written to the tty/pty and can be used to
290suppress or filter tty input.
291
230=item on_line_update $term, $row 292=item on_line_update $term, $row
231 293
232Called whenever a line was updated or changed. Can be used to filter 294Called whenever a line was updated or changed. Can be used to filter
233screen output (e.g. underline urls or other useless stuff). Only lines 295screen output (e.g. underline urls or other useless stuff). Only lines
234that are being shown will be filtered, and, due to performance reasons, 296that are being shown will be filtered, and, due to performance reasons,
266=item on_focus_out $term 328=item on_focus_out $term
267 329
268Called wheneever the window loses keyboard focus, before rxvt-unicode does 330Called wheneever the window loses keyboard focus, before rxvt-unicode does
269focus out processing. 331focus out processing.
270 332
271=item on_key_press $term, $event, $octets 333=item on_key_press $term, $event, $keysym, $octets
272 334
273=item on_key_release $term, $event 335=item on_key_release $term, $event, $keysym
274 336
275=item on_button_press $term, $event 337=item on_button_press $term, $event
276 338
277=item on_button_release $term, $event 339=item on_button_release $term, $event
278 340
294 356
295subwindow. 357subwindow.
296 358
297=back 359=back
298 360
361=cut
362
363package urxvt;
364
365use utf8;
366use strict;
367use Carp ();
368use Scalar::Util ();
369use List::Util ();
370
371our $VERSION = 1;
372our $TERM;
373our @HOOKNAME;
374our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
375our %OPTION;
376
377our $LIBDIR;
378our $RESNAME;
379our $RESCLASS;
380our $RXVTNAME;
381
299=head2 Variables in the C<urxvt> Package 382=head2 Variables in the C<urxvt> Package
300 383
301=over 4 384=over 4
385
386=item $urxvt::LIBDIR
387
388The rxvt-unicode library directory, where, among other things, the perl
389modules and scripts are stored.
390
391=item $urxvt::RESCLASS, $urxvt::RESCLASS
392
393The resource class and name rxvt-unicode uses to look up X resources.
394
395=item $urxvt::RXVTNAME
396
397The basename of the installed binaries, usually C<urxvt>.
302 398
303=item $urxvt::TERM 399=item $urxvt::TERM
304 400
305The current terminal. This variable stores the current C<urxvt::term> 401The current terminal. This variable stores the current C<urxvt::term>
306object, whenever a callback/hook is executing. 402object, whenever a callback/hook is executing.
308=back 404=back
309 405
310=head2 Functions in the C<urxvt> Package 406=head2 Functions in the C<urxvt> Package
311 407
312=over 4 408=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 409
322=item urxvt::fatal $errormessage 410=item urxvt::fatal $errormessage
323 411
324Fatally aborts execution with the given error message. Avoid at all 412Fatally aborts execution with the given error message. Avoid at all
325costs! The only time this is acceptable is when the terminal process 413costs! The only time this is acceptable is when the terminal process
331newline. The module also overwrites the C<warn> builtin with a function 419newline. The module also overwrites the C<warn> builtin with a function
332that calls this function. 420that calls this function.
333 421
334Using this function has the advantage that its output ends up in the 422Using this function has the advantage that its output ends up in the
335correct place, e.g. on stderr of the connecting urxvtc client. 423correct place, e.g. on stderr of the connecting urxvtc client.
424
425Messages have a size limit of 1023 bytes currently.
426
427=item $is_safe = urxvt::safe
428
429Returns true when it is safe to do potentially unsafe things, such as
430evaluating perl code specified by the user. This is true when urxvt was
431started setuid or setgid.
336 432
337=item $time = urxvt::NOW 433=item $time = urxvt::NOW
338 434
339Returns the "current time" (as per the event loop). 435Returns the "current time" (as per the event loop).
340 436
379 475
380=item $background = urxvt::GET_BASEBG $rend 476=item $background = urxvt::GET_BASEBG $rend
381 477
382Return the foreground/background colour index, respectively. 478Return the foreground/background colour index, respectively.
383 479
384=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) 480=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
385 481
386=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) 482=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
387 483
388Replace the foreground/background colour in the rendition mask with the 484Replace the foreground/background colour in the rendition mask with the
389specified one. 485specified one.
390 486
391=item $value = urxvt::GET_CUSTOM ($rend) 487=item $value = urxvt::GET_CUSTOM $rend
392 488
393Return the "custom" value: Every rendition has 5 bits for use by 489Return the "custom" value: Every rendition has 5 bits for use by
394extensions. They can be set and changed as you like and are initially 490extensions. They can be set and changed as you like and are initially
395zero. 491zero.
396 492
397=item $rend = urxvt::SET_CUSTOM ($rend, $new_value) 493=item $rend = urxvt::SET_CUSTOM $rend, $new_value
398 494
399Change the custom value. 495Change the custom value.
400 496
401=back 497=back
402 498
403=cut 499=cut
404
405package urxvt;
406
407use utf8;
408use strict;
409use Scalar::Util ();
410use List::Util ();
411
412our $VERSION = 1;
413our $TERM;
414our @HOOKNAME;
415our %OPTION;
416our $LIBDIR;
417 500
418BEGIN { 501BEGIN {
419 urxvt->bootstrap; 502 urxvt->bootstrap;
420 503
421 # overwrite perl's warn 504 # overwrite perl's warn
423 my $msg = join "", @_; 506 my $msg = join "", @_;
424 $msg .= "\n" 507 $msg .= "\n"
425 unless $msg =~ /\n$/; 508 unless $msg =~ /\n$/;
426 urxvt::warn ($msg); 509 urxvt::warn ($msg);
427 }; 510 };
511
512 # %ENV is the original startup environment
513 delete $ENV{IFS};
514 delete $ENV{CDPATH};
515 delete $ENV{BASH_ENV};
516 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
428} 517}
429 518
430my @hook_count; 519my @hook_count;
431my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 520my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
432 521
433sub verbose { 522sub verbose {
434 my ($level, $msg) = @_; 523 my ($level, $msg) = @_;
435 warn "$msg\n" if $level <= $verbosity; 524 warn "$msg\n" if $level <= $verbosity;
436} 525}
437 526
438# find on_xxx subs in the package and register them
439# as hooks
440sub register_package($) {
441 my ($pkg) = @_;
442
443 for my $htype (0.. $#HOOKNAME) {
444 my $name = $HOOKNAME[$htype];
445
446 my $ref = $pkg->can ("on_" . lc $name)
447 or next;
448
449 $TERM->{_hook}[$htype]{$pkg} = $ref;
450 $hook_count[$htype]++
451 or set_should_invoke $htype, 1;
452 }
453}
454
455my $extension_pkg = "extension0000"; 527my $extension_pkg = "extension0000";
456my %extension_pkg; 528my %extension_pkg;
457 529
458# load a single script into its own package, once only 530# load a single script into its own package, once only
459sub extension_package($) { 531sub extension_package($) {
465 verbose 3, "loading extension '$path' into package '$pkg'"; 537 verbose 3, "loading extension '$path' into package '$pkg'";
466 538
467 open my $fh, "<:raw", $path 539 open my $fh, "<:raw", $path
468 or die "$path: $!"; 540 or die "$path: $!";
469 541
542 my $source = untaint
470 my $source = "package $pkg; use strict; use utf8;\n" 543 "package $pkg; use strict; use utf8;\n"
471 . "use base urxvt::term::proxy::;\n" 544 . "use base urxvt::term::extension::;\n"
472 . "#line 1 \"$path\"\n{\n" 545 . "#line 1 \"$path\"\n{\n"
473 . (do { local $/; <$fh> }) 546 . (do { local $/; <$fh> })
474 . "\n};\n1"; 547 . "\n};\n1";
475 548
476 $source =~ /(.*)/s and $source = $1; # untaint 549 eval $source
477
478 eval $source or die "$path: $@"; 550 or die "$path: $@";
479 551
480 $pkg 552 $pkg
481 } 553 }
482} 554}
483 555
489 my $htype = shift; 561 my $htype = shift;
490 562
491 if ($htype == 0) { # INIT 563 if ($htype == 0) { # INIT
492 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 564 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
493 565
494 my %want_ext; 566 my %ext_arg;
495 567
496 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 568 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
497 if ($_ eq "default") { 569 if ($_ eq "default") {
498 $want_ext{$_}++ for qw(selection option-popup); 570 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
499 } elsif (/^-(.*)$/) { 571 } elsif (/^-(.*)$/) {
500 delete $want_ext{$1}; 572 delete $ext_arg{$1};
573 } elsif (/^([^<]+)<(.*)>$/) {
574 push @{ $ext_arg{$1} }, $2;
501 } else { 575 } else {
502 $want_ext{$_}++; 576 $ext_arg{$_} ||= [];
503 } 577 }
504 } 578 }
505 579
506 for my $ext (keys %want_ext) { 580 while (my ($ext, $argv) = each %ext_arg) {
507 my @files = grep -f $_, map "$_/$ext", @dirs; 581 my @files = grep -f $_, map "$_/$ext", @dirs;
508 582
509 if (@files) { 583 if (@files) {
510 register_package extension_package $files[0]; 584 $TERM->register_package (extension_package $files[0], $argv);
511 } else { 585 } else {
512 warn "perl extension '$ext' not found in perl library search path\n"; 586 warn "perl extension '$ext' not found in perl library search path\n";
513 } 587 }
514 } 588 }
515 589
524 if $verbosity >= 10; 598 if $verbosity >= 10;
525 599
526 keys %$cb; 600 keys %$cb;
527 601
528 while (my ($pkg, $cb) = each %$cb) { 602 while (my ($pkg, $cb) = each %$cb) {
529 eval { 603 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
530 $retval = $cb->(
531 $TERM->{_pkg}{$pkg} ||= do {
532 my $proxy = bless { }, $pkg;
533 Scalar::Util::weaken ($proxy->{term} = $TERM);
534 $proxy
535 },
536 @_,
537 ) and last; 604 and last;
538 }; 605
539 if ($@) { 606 if ($@) {
540 $TERM->ungrab; # better to lose the grab than the session 607 $TERM->ungrab; # better to lose the grab than the session
541 warn $@; 608 warn $@;
542 } 609 }
543 } 610 }
611
612 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
613 if $verbosity >= 11;
544 } 614 }
545 615
546 if ($htype == 1) { # DESTROY 616 if ($htype == 1) { # DESTROY
547 # remove hooks if unused
548 if (my $hook = $TERM->{_hook}) { 617 if (my $hook = delete $TERM->{_hook}) {
549 for my $htype (0..$#$hook) { 618 for my $htype (0..$#$hook) {
550 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } 619 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
551 or set_should_invoke $htype, 0; 620 or set_should_invoke $htype, 0;
552 } 621 }
553 } 622 }
560 } 629 }
561 630
562 $retval 631 $retval
563} 632}
564 633
565# urxvt::term::proxy 634sub exec_async(@) {
635 my $pid = fork;
566 636
567sub urxvt::term::proxy::AUTOLOAD { 637 return
568 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 638 if !defined $pid or $pid;
639
640 %ENV = %{ $TERM->env };
641
642 exec @_;
643 _exit 255;
644}
645
646# urxvt::term::extension
647
648package urxvt::term::extension;
649
650sub enable {
651 my ($self, %hook) = @_;
652 my $pkg = $self->{_pkg};
653
654 while (my ($name, $cb) = each %hook) {
655 my $htype = $HOOKTYPE{uc $name};
656 defined $htype
657 or Carp::croak "unsupported hook type '$name'";
658
659 unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
660 $hook_count[$htype]++
661 or urxvt::set_should_invoke $htype, 1;
662 }
663
664 $self->{term}{_hook}[$htype]{$pkg} = $cb;
665 }
666}
667
668sub disable {
669 my ($self, @hook) = @_;
670 my $pkg = $self->{_pkg};
671
672 for my $name (@hook) {
673 my $htype = $HOOKTYPE{uc $name};
674 defined $htype
675 or Carp::croak "unsupported hook type '$name'";
676
677 if (delete $self->{term}{_hook}[$htype]{$pkg}) {
678 --$hook_count[$htype]
679 or urxvt::set_should_invoke $htype, 0;
680 }
681 }
682}
683
684our $AUTOLOAD;
685
686sub AUTOLOAD {
687 $AUTOLOAD =~ /:([^:]+)$/
569 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 688 or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
570 689
571 eval qq{ 690 eval qq{
572 sub $urxvt::term::proxy::AUTOLOAD { 691 sub $AUTOLOAD {
573 my \$proxy = shift; 692 my \$proxy = shift;
574 \$proxy->{term}->$1 (\@_) 693 \$proxy->{term}->$1 (\@_)
575 } 694 }
576 1 695 1
577 } or die "FATAL: unable to compile method forwarder: $@"; 696 } or die "FATAL: unable to compile method forwarder: $@";
578 697
579 goto &$urxvt::term::proxy::AUTOLOAD; 698 goto &$AUTOLOAD;
580} 699}
581 700
582sub urxvt::term::proxy::DESTROY { 701sub DESTROY {
583 # nop 702 # nop
584} 703}
585 704
586# urxvt::destroy_hook 705# urxvt::destroy_hook
587 706
597 716
598=head2 The C<urxvt::anyevent> Class 717=head2 The C<urxvt::anyevent> Class
599 718
600The sole purpose of this class is to deliver an interface to the 719The sole purpose of this class is to deliver an interface to the
601C<AnyEvent> module - any module using it will work inside urxvt without 720C<AnyEvent> module - any module using it will work inside urxvt without
602further work. The only exception is that you cannot wait on condition 721further programming. The only exception is that you cannot wait on
603variables, but non-blocking condvar use is ok. What this means is that you 722condition variables, but non-blocking condvar use is ok. What this means
604cannot use blocking APIs, but the non-blocking variant should work. 723is that you cannot use blocking APIs, but the non-blocking variant should
724work.
605 725
606=cut 726=cut
607 727
608our $VERSION = 1; 728our $VERSION = 1;
609 729
654 ${$_[0]}++; 774 ${$_[0]}++;
655} 775}
656 776
657sub urxvt::anyevent::condvar::wait { 777sub urxvt::anyevent::condvar::wait {
658 unless (${$_[0]}) { 778 unless (${$_[0]}) {
659 require Carp;
660 Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"); 779 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
661 } 780 }
662} 781}
663 782
664package urxvt::term; 783package urxvt::term;
665 784
666=head2 The C<urxvt::term> Class 785=head2 The C<urxvt::term> Class
667 786
668=over 4 787=over 4
669 788
789=cut
790
791# find on_xxx subs in the package and register them
792# as hooks
793sub register_package {
794 my ($self, $pkg, $argv) = @_;
795
796 my $proxy = bless {
797 _pkg => $pkg,
798 argv => $argv,
799 }, $pkg;
800 Scalar::Util::weaken ($proxy->{term} = $self);
801
802 $self->{_pkg}{$pkg} = $proxy;
803
804 for my $name (@HOOKNAME) {
805 if (my $ref = $pkg->can ("on_" . lc $name)) {
806 $proxy->enable ($name => $ref);
807 }
808 }
809}
810
811=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
812
813Creates a new terminal, very similar as if you had started it with system
814C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
815hash which defines the environment of the new terminal.
816
817Croaks (and probably outputs an error message) if the new instance
818couldn't be created. Returns C<undef> if the new instance didn't
819initialise perl, and the terminal object otherwise. The C<init> and
820C<start> hooks will be called during this call.
821
822=cut
823
824sub new {
825 my ($class, $env, @args) = @_;
826
827 _new ([ map "$_=$env->{$_}", keys %$env ], @args);
828}
829
670=item $term->destroy 830=item $term->destroy
671 831
672Destroy the terminal object (close the window, free resources etc.). 832Destroy the terminal object (close the window, free resources
833etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
834watchers (timers, io watchers) are still active.
673 835
674=item $isset = $term->option ($optval[, $set]) 836=item $isset = $term->option ($optval[, $set])
675 837
676Returns true if the option specified by C<$optval> is enabled, and 838Returns true if the option specified by C<$optval> is enabled, and
677optionally change it. All option values are stored by name in the hash 839optionally change it. All option values are stored by name in the hash
727 my ($self, $name) = (shift, shift); 889 my ($self, $name) = (shift, shift);
728 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 890 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
729 &urxvt::term::_resource 891 &urxvt::term::_resource
730} 892}
731 893
894=item $value = $term->x_resource ($pattern)
895
896Returns the X-Resource for the given pattern, excluding the program or
897class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
898same value as used by this instance of rxvt-unicode. Returns C<undef> if no
899resource with that pattern exists.
900
901This method should only be called during the C<on_start> hook, as there is
902only one resource database per display, and later invocations might return
903the wrong resources.
904
905=item $success = $term->parse_keysym ($keysym_spec, $command_string)
906
907Adds a keymap translation exactly as specified via a resource. See the
908C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
909
732=item $rend = $term->rstyle ([$new_rstyle]) 910=item $rend = $term->rstyle ([$new_rstyle])
733 911
734Return and optionally change the current rendition. Text that is output by 912Return and optionally change the current rendition. Text that is output by
735the terminal application will use this style. 913the terminal application will use this style.
736 914
746=item ($row, $col) = $term->selection_end ([$row, $col]) 924=item ($row, $col) = $term->selection_end ([$row, $col])
747 925
748Return the current values of the selection mark, begin or end positions, 926Return the current values of the selection mark, begin or end positions,
749and optionally set them to new values. 927and optionally set them to new values.
750 928
929=item $term->selection_make ($eventtime[, $rectangular])
930
931Tries to make a selection as set by C<selection_beg> and
932C<selection_end>. If C<$rectangular> is true (default: false), a
933rectangular selection will be made. This is the prefered function to make
934a selection.
935
751=item $success = $term->selection_grab ($eventtime) 936=item $success = $term->selection_grab ($eventtime)
752 937
753Try to request the primary selection from the server (for example, as set 938Try to request the primary selection text from the server (for example, as
754by the next method). 939set by the next method). No visual feedback will be given. This function
940is mostly useful from within C<on_sel_grab> hooks.
755 941
756=item $oldtext = $term->selection ([$newtext]) 942=item $oldtext = $term->selection ([$newtext])
757 943
758Return the current selection text and optionally replace it by C<$newtext>. 944Return the current selection text and optionally replace it by C<$newtext>.
759 945
760#=item $term->overlay ($x, $y, $text) 946=item $term->overlay_simple ($x, $y, $text)
761# 947
762#Create a simple multi-line overlay box. See the next method for details. 948Create a simple multi-line overlay box. See the next method for details.
763# 949
764#=cut 950=cut
765# 951
766#sub urxvt::term::scr_overlay { 952sub overlay_simple {
767# my ($self, $x, $y, $text) = @_; 953 my ($self, $x, $y, $text) = @_;
768# 954
769# my @lines = split /\n/, $text; 955 my @lines = split /\n/, $text;
770# 956
771# my $w = 0; 957 my $w = List::Util::max map $self->strwidth ($_), @lines;
772# for (map $self->strwidth ($_), @lines) { 958
773# $w = $_ if $w < $_;
774# }
775#
776# $self->scr_overlay_new ($x, $y, $w, scalar @lines); 959 my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
777# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; 960 $overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
778#} 961
962 $overlay
963}
779 964
780=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) 965=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
781 966
782Create a new (empty) overlay at the given position with the given 967Create a new (empty) overlay at the given position with the given
783width/height. C<$rstyle> defines the initial rendition style 968width/height. C<$rstyle> defines the initial rendition style
850 1035
851=item $string = $term->locale_decode ($octets) 1036=item $string = $term->locale_decode ($octets)
852 1037
853Convert the given locale-encoded octets into a perl string. 1038Convert the given locale-encoded octets into a perl string.
854 1039
1040=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1041
1042XORs the rendition values in the given span with the provided value
1043(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
1044refresh hooks to provide effects similar to the selection.
1045
1046=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1047
1048Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1049whitespace will additionally be xored with the C<$rstyle2>, which defaults
1050to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1051it instead. Both styles I<MUST NOT> contain font styles.
1052
1053=item $term->scr_bell
1054
1055Ring the bell!
1056
855=item $term->scr_add_lines ($string) 1057=item $term->scr_add_lines ($string)
856 1058
857Write the given text string to the screen, as if output by the application 1059Write the given text string to the screen, as if output by the application
858running inside the terminal. It may not contain command sequences (escape 1060running inside the terminal. It may not contain command sequences (escape
859codes), but is free to use line feeds, carriage returns and tabs. The 1061codes), but is free to use line feeds, carriage returns and tabs. The
873 1075
874Write the octets given in C<$data> to the tty (i.e. as program input). To 1076Write the octets given in C<$data> to the tty (i.e. as program input). To
875pass characters instead of octets, you should convert your strings first 1077pass characters instead of octets, you should convert your strings first
876to the locale-specific encoding using C<< $term->locale_encode >>. 1078to the locale-specific encoding using C<< $term->locale_encode >>.
877 1079
1080=item $old_events = $term->pty_ev_events ([$new_events])
1081
1082Replaces the event mask of the pty watcher by the given event mask. Can
1083be used to suppress input and output handling to the pty/tty. See the
1084description of C<< urxvt::timer->events >>. Make sure to always restore
1085the previous value.
1086
878=item $windowid = $term->parent 1087=item $windowid = $term->parent
879 1088
880Return the window id of the toplevel window. 1089Return the window id of the toplevel window.
881 1090
882=item $windowid = $term->vt 1091=item $windowid = $term->vt
906=item $nrow_plus_saveLines = $term->total_rows 1115=item $nrow_plus_saveLines = $term->total_rows
907 1116
908=item $lines_in_scrollback = $term->nsaved 1117=item $lines_in_scrollback = $term->nsaved
909 1118
910Return various integers describing terminal characteristics. 1119Return various integers describing terminal characteristics.
1120
1121=item $x_display = $term->display_id
1122
1123Return the DISPLAY used by rxvt-unicode.
1124
1125=item $lc_ctype = $term->locale
1126
1127Returns the LC_CTYPE category string used by this rxvt-unicode.
1128
1129=item $env = $term->env
1130
1131Returns a copy of the environment in effect for the terminal as a hashref
1132similar to C<\%ENV>.
1133
1134=cut
1135
1136sub env {
1137 if (my $env = $_[0]->_env) {
1138 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
1139 } else {
1140 +{ %ENV }
1141 }
1142}
911 1143
912=item $modifiermask = $term->ModLevel3Mask 1144=item $modifiermask = $term->ModLevel3Mask
913 1145
914=item $modifiermask = $term->ModMetaMask 1146=item $modifiermask = $term->ModMetaMask
915 1147
1008Return the row number of the first/last row of the line, respectively. 1240Return the row number of the first/last row of the line, respectively.
1009 1241
1010=item $offset = $line->offset_of ($row, $col) 1242=item $offset = $line->offset_of ($row, $col)
1011 1243
1012Returns the character offset of the given row|col pair within the logical 1244Returns the character offset of the given row|col pair within the logical
1013line. 1245line. Works for rows outside the line, too, and returns corresponding
1246offsets outside the string.
1014 1247
1015=item ($row, $col) = $line->coord_of ($offset) 1248=item ($row, $col) = $line->coord_of ($offset)
1016 1249
1017Translates a string offset into terminal coordinates again. 1250Translates a string offset into terminal coordinates again.
1018 1251
1092 $offset / $self->{ncol} + $self->{beg}, 1325 $offset / $self->{ncol} + $self->{beg},
1093 $offset % $self->{ncol} 1326 $offset % $self->{ncol}
1094 ) 1327 )
1095} 1328}
1096 1329
1097=item ($row, $col) = $line->coord_of ($offset)
1098=item $text = $term->special_encode $string 1330=item $text = $term->special_encode $string
1099 1331
1100Converts a perl string into the special encoding used by rxvt-unicode, 1332Converts a perl string into the special encoding used by rxvt-unicode,
1101where one character corresponds to one screen cell. See 1333where one character corresponds to one screen cell. See
1102C<< $term->ROW_t >> for details. 1334C<< $term->ROW_t >> for details.
1104=item $string = $term->special_decode $text 1336=item $string = $term->special_decode $text
1105 1337
1106Converts rxvt-unicodes text reprsentation into a perl string. See 1338Converts rxvt-unicodes text reprsentation into a perl string. See
1107C<< $term->ROW_t >> for details. 1339C<< $term->ROW_t >> for details.
1108 1340
1341=item $success = $term->grab_button ($button, $modifiermask)
1342
1343Registers a synchronous button grab. See the XGrabButton manpage.
1344
1345=item $success = $term->grab ($eventtime[, $sync])
1346
1347Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1348synchronous (C<$sync> is true). Also remembers the grab timestampe.
1349
1350=item $term->allow_events_async
1351
1352Calls XAllowEvents with AsyncBoth for the most recent grab.
1353
1354=item $term->allow_events_sync
1355
1356Calls XAllowEvents with SyncBoth for the most recent grab.
1357
1358=item $term->allow_events_replay
1359
1360Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1361recent grab.
1362
1363=item $term->ungrab
1364
1365Calls XUngrab for the most recent grab. Is called automatically on
1366evaluation errors, as it is better to lose the grab in the error case as
1367the session.
1368
1109=back 1369=back
1110 1370
1111=cut 1371=cut
1112 1372
1113package urxvt::popup; 1373package urxvt::popup;
1128 $item->{render} ||= sub { $_[0]{text} }; 1388 $item->{render} ||= sub { $_[0]{text} };
1129 1389
1130 push @{ $self->{item} }, $item; 1390 push @{ $self->{item} }, $item;
1131} 1391}
1132 1392
1133sub add_separator { 1393=item $popup->add_title ($title)
1134 my ($self, $sep) = @_;
1135 1394
1136 $sep ||= "═"; 1395Adds a non-clickable title to the popup.
1137 1396
1138 $self->add_item ({ 1397=cut
1139 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1140 text => "",
1141 render => sub { $sep x $urxvt::TERM->ncol },
1142 activate => sub { },
1143 });
1144}
1145 1398
1146sub add_title { 1399sub add_title {
1147 my ($self, $title) = @_; 1400 my ($self, $title) = @_;
1148 1401
1149 $self->add_item ({ 1402 $self->add_item ({
1151 text => $title, 1404 text => $title,
1152 activate => sub { }, 1405 activate => sub { },
1153 }); 1406 });
1154} 1407}
1155 1408
1409=item $popup->add_separator ([$sepchr])
1410
1411Creates a separator, optionally using the character given as C<$sepchr>.
1412
1413=cut
1414
1415sub add_separator {
1416 my ($self, $sep) = @_;
1417
1418 $sep ||= "=";
1419
1420 $self->add_item ({
1421 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1422 text => "",
1423 render => sub { $sep x $self->{term}->ncol },
1424 activate => sub { },
1425 });
1426}
1427
1428=item $popup->add_button ($text, $cb)
1429
1430Adds a clickable button to the popup. C<$cb> is called whenever it is
1431selected.
1432
1433=cut
1434
1156sub add_button { 1435sub add_button {
1157 my ($self, $text, $cb) = @_; 1436 my ($self, $text, $cb) = @_;
1158 1437
1159 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb}); 1438 $self->add_item ({ type => "button", text => $text, activate => $cb});
1160} 1439}
1440
1441=item $popup->add_toggle ($text, $cb, $initial_value)
1442
1443Adds a toggle/checkbox item to the popup. Teh callback gets called
1444whenever it gets toggled, with a boolean indicating its value as its first
1445argument.
1446
1447=cut
1161 1448
1162sub add_toggle { 1449sub add_toggle {
1163 my ($self, $text, $cb, $value) = @_; 1450 my ($self, $text, $cb, $value) = @_;
1164 1451
1165 my $item; $item = { 1452 my $item; $item = {
1166 type => "button", 1453 type => "button",
1167 text => " $text", 1454 text => " $text",
1168 value => $value, 1455 value => $value,
1169 render => sub { ($_[0]{value} ? "* " : " ") . $text }, 1456 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1170 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); }, 1457 activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1171 }; 1458 };
1172 1459
1173 $self->add_item ($item); 1460 $self->add_item ($item);
1174} 1461}
1462
1463=item $popup->show
1464
1465Displays the popup (which is initially hidden).
1466
1467=cut
1175 1468
1176sub show { 1469sub show {
1177 my ($self) = @_; 1470 my ($self) = @_;
1178 1471
1179 local $urxvt::popup::self = $self; 1472 local $urxvt::popup::self = $self;
1180 1473
1474 my $env = $self->{term}->env;
1475 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1476 delete $env->{LC_ALL};
1477 $env->{LC_CTYPE} = $self->{term}->locale;
1478
1479 urxvt::term->new ($env, $self->{term}->resource ("name"),
1181 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1480 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1182 "--transient-for" => $self->{term}->parent, 1481 "--transient-for" => $self->{term}->parent,
1482 "-display" => $self->{term}->display_id,
1183 "-pe" => "urxvt-popup") 1483 "-pe" => "urxvt-popup")
1184 or die "unable to create popup window\n"; 1484 or die "unable to create popup window\n";
1185} 1485}
1186 1486
1187sub DESTROY { 1487sub DESTROY {
1188 my ($self) = @_; 1488 my ($self) = @_;
1189 1489
1190 delete $self->{term}{_destroy}{$self}; 1490 delete $self->{term}{_destroy}{$self};
1191 $self->{term}->ungrab; 1491 $self->{term}->ungrab;
1192} 1492}
1493
1494=back
1193 1495
1194=head2 The C<urxvt::timer> Class 1496=head2 The C<urxvt::timer> Class
1195 1497
1196This class implements timer watchers/events. Time is represented as a 1498This class implements timer watchers/events. Time is represented as a
1197fractional number of seconds since the epoch. Example: 1499fractional number of seconds since the epoch. Example:
1250 1552
1251 $term->{socket} = ... 1553 $term->{socket} = ...
1252 $term->{iow} = urxvt::iow 1554 $term->{iow} = urxvt::iow
1253 ->new 1555 ->new
1254 ->fd (fileno $term->{socket}) 1556 ->fd (fileno $term->{socket})
1255 ->events (1) # wait for read data 1557 ->events (urxvt::EVENT_READ)
1256 ->start 1558 ->start
1257 ->cb (sub { 1559 ->cb (sub {
1258 my ($iow, $revents) = @_; 1560 my ($iow, $revents) = @_;
1259 # $revents must be 1 here, no need to check 1561 # $revents must be 1 here, no need to check
1260 sysread $term->{socket}, my $buf, 8192 1562 sysread $term->{socket}, my $buf, 8192
1277 1579
1278Set the filedescriptor (not handle) to watch. 1580Set the filedescriptor (not handle) to watch.
1279 1581
1280=item $iow = $iow->events ($eventmask) 1582=item $iow = $iow->events ($eventmask)
1281 1583
1282Set the event mask to watch. Bit #0 (value C<1>) enables watching for read 1584Set the event mask to watch. The only allowed values are
1283data, Bit #1 (value C<2>) enables watching for write data. 1585C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
1586together, or C<urxvt::EVENT_NONE>.
1284 1587
1285=item $iow = $iow->start 1588=item $iow = $iow->start
1286 1589
1287Start watching for requested events on the given handle. 1590Start watching for requested events on the given handle.
1288 1591
1303 1606
1304=item == 0 - fatal messages 1607=item == 0 - fatal messages
1305 1608
1306=item >= 3 - script loading and management 1609=item >= 3 - script loading and management
1307 1610
1308=item >=10 - all events received 1611=item >=10 - all called hooks
1612
1613=item >=11 - hook reutrn values
1309 1614
1310=back 1615=back
1311 1616
1312=head1 AUTHOR 1617=head1 AUTHOR
1313 1618

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines