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.59 by root, Mon Jan 9 00:34:36 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
64runtime. 68runtime.
65 69
66=item selection-popup (enabled by default) 70=item selection-popup (enabled by default)
67 71
68Binds a popup menu to Ctrl-Button3 that lets you convert the selection 72Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69text into various other formats/action. 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.
70 90
71=item digital-clock 91=item digital-clock
72 92
73Displays a digital clock using the built-in overlay. 93Displays a digital clock using the built-in overlay.
74 94
75=item mark-urls 95=item mark-urls
76 96
77Uses 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.
78 101
79=item block-graphics-to-ascii 102=item block-graphics-to-ascii
80 103
81A 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,
82by replacing all line-drawing characters (U+2500 .. U+259F) by a 105by replacing all line-drawing characters (U+2500 .. U+259F) by a
87Displays 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
88window. Illustrates overwriting the refresh callbacks to create your own 111window. Illustrates overwriting the refresh callbacks to create your own
89overlays or changes. 112overlays or changes.
90 113
91=back 114=back
115
116=head1 API DOCUMENTATION
92 117
93=head2 General API Considerations 118=head2 General API Considerations
94 119
95All objects (such as terminals, time watchers etc.) are typical 120All objects (such as terminals, time watchers etc.) are typical
96reference-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
109=over 4 134=over 4
110 135
111=item $text 136=item $text
112 137
113Rxvt-unicodes special way of encoding text, where one "unicode" character 138Rxvt-unicodes special way of encoding text, where one "unicode" character
114always 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.
115 140
116=item $string 141=item $string
117 142
118A 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
119characters and is to be distinguished with text encoded in a specific 144characters and is to be distinguished with text encoded in a specific
124Either binary data or - more common - a text string encoded in a 149Either binary data or - more common - a text string encoded in a
125locale-specific way. 150locale-specific way.
126 151
127=back 152=back
128 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
129=head2 Hooks 187=head2 Hooks
130 188
131The following subroutines can be declared in extension files, and will be 189The following subroutines can be declared in extension files, and will be
132called whenever the relevant event happens. 190called whenever the relevant event happens.
133 191
134The 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
135and extension package. You can call all C<urxvt::term> methods on it, but 193the in the C<Extension Objects> section.
136its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
137object that is shared between all packages is stored in the C<term>
138member. It is, however, blessed intot he package of the extension script,
139so for all practical purposes you can treat an extension script as a class.
140 194
141All 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
142counts 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
143and 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.
144 198
145When in doubt, return a false value (preferably C<()>). 199I<< When in doubt, return a false value (preferably C<()>). >>
146 200
147=over 4 201=over 4
148 202
149=item on_init $term 203=item on_init $term
150 204
185=item on_sel_extend $term 239=item on_sel_extend $term
186 240
187Called 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
188click) and is either supposed to return false (normal operation), or 242click) and is either supposed to return false (normal operation), or
189should 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
190processing. 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.
191 247
192See the F<selection> example extension. 248See the F<selection> example extension.
193 249
194=item on_view_change $term, $offset 250=item on_view_change $term, $offset
195 251
204than the scroll back buffer or the terminal. 260than the scroll back buffer or the terminal.
205 261
206It 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,
207$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
208number of lines that will be in the scrollback buffer. 264number of lines that will be in the scrollback buffer.
209
210=item on_tty_activity $term *NYI*
211
212Called whenever the program(s) running in the urxvt window send output.
213 265
214=item on_osc_seq $term, $string 266=item on_osc_seq $term, $string
215 267
216Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 268Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
217operating system command) is processed. Cursor position and other state 269operating system command) is processed. Cursor position and other state
230can 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
231and calling C<< $term->scr_add_lines >> yourself. Please note that this 283and calling C<< $term->scr_add_lines >> yourself. Please note that this
232might 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
233output. 285output.
234 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
235=item on_line_update $term, $row 292=item on_line_update $term, $row
236 293
237Called 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
238screen output (e.g. underline urls or other useless stuff). Only lines 295screen output (e.g. underline urls or other useless stuff). Only lines
239that are being shown will be filtered, and, due to performance reasons, 296that are being shown will be filtered, and, due to performance reasons,
271=item on_focus_out $term 328=item on_focus_out $term
272 329
273Called wheneever the window loses keyboard focus, before rxvt-unicode does 330Called wheneever the window loses keyboard focus, before rxvt-unicode does
274focus out processing. 331focus out processing.
275 332
276=item on_key_press $term, $event, $octets 333=item on_key_press $term, $event, $keysym, $octets
277 334
278=item on_key_release $term, $event 335=item on_key_release $term, $event, $keysym
279 336
280=item on_button_press $term, $event 337=item on_button_press $term, $event
281 338
282=item on_button_release $term, $event 339=item on_button_release $term, $event
283 340
299 356
300subwindow. 357subwindow.
301 358
302=back 359=back
303 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
304=head2 Variables in the C<urxvt> Package 382=head2 Variables in the C<urxvt> Package
305 383
306=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>.
307 398
308=item $urxvt::TERM 399=item $urxvt::TERM
309 400
310The current terminal. This variable stores the current C<urxvt::term> 401The current terminal. This variable stores the current C<urxvt::term>
311object, whenever a callback/hook is executing. 402object, whenever a callback/hook is executing.
313=back 404=back
314 405
315=head2 Functions in the C<urxvt> Package 406=head2 Functions in the C<urxvt> Package
316 407
317=over 4 408=over 4
318
319=item $term = new urxvt [arg...]
320
321Creates a new terminal, very similar as if you had started it with
322C<system $binfile, arg...>. Croaks (and probably outputs an error message)
323if the new instance couldn't be created. Returns C<undef> if the new
324instance didn't initialise perl, and the terminal object otherwise. The
325C<init> and C<start> hooks will be called during the call.
326 409
327=item urxvt::fatal $errormessage 410=item urxvt::fatal $errormessage
328 411
329Fatally aborts execution with the given error message. Avoid at all 412Fatally aborts execution with the given error message. Avoid at all
330costs! The only time this is acceptable is when the terminal process 413costs! The only time this is acceptable is when the terminal process
336newline. The module also overwrites the C<warn> builtin with a function 419newline. The module also overwrites the C<warn> builtin with a function
337that calls this function. 420that calls this function.
338 421
339Using 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
340correct 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.
341 432
342=item $time = urxvt::NOW 433=item $time = urxvt::NOW
343 434
344Returns the "current time" (as per the event loop). 435Returns the "current time" (as per the event loop).
345 436
384 475
385=item $background = urxvt::GET_BASEBG $rend 476=item $background = urxvt::GET_BASEBG $rend
386 477
387Return the foreground/background colour index, respectively. 478Return the foreground/background colour index, respectively.
388 479
389=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) 480=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
390 481
391=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) 482=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
392 483
393Replace the foreground/background colour in the rendition mask with the 484Replace the foreground/background colour in the rendition mask with the
394specified one. 485specified one.
395 486
396=item $value = urxvt::GET_CUSTOM ($rend) 487=item $value = urxvt::GET_CUSTOM $rend
397 488
398Return the "custom" value: Every rendition has 5 bits for use by 489Return the "custom" value: Every rendition has 5 bits for use by
399extensions. 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
400zero. 491zero.
401 492
402=item $rend = urxvt::SET_CUSTOM ($rend, $new_value) 493=item $rend = urxvt::SET_CUSTOM $rend, $new_value
403 494
404Change the custom value. 495Change the custom value.
405 496
406=back 497=back
407 498
408=cut 499=cut
409
410package urxvt;
411
412use utf8;
413use strict;
414use Scalar::Util ();
415use List::Util ();
416
417our $VERSION = 1;
418our $TERM;
419our @HOOKNAME;
420our %OPTION;
421our $LIBDIR;
422 500
423BEGIN { 501BEGIN {
424 urxvt->bootstrap; 502 urxvt->bootstrap;
425 503
426 # overwrite perl's warn 504 # overwrite perl's warn
429 $msg .= "\n" 507 $msg .= "\n"
430 unless $msg =~ /\n$/; 508 unless $msg =~ /\n$/;
431 urxvt::warn ($msg); 509 urxvt::warn ($msg);
432 }; 510 };
433 511
512 # %ENV is the original startup environment
513 delete $ENV{IFS};
514 delete $ENV{CDPATH};
515 delete $ENV{BASH_ENV};
434 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; 516 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
435 delete $ENV{CDPATH};
436} 517}
437 518
438my @hook_count; 519my @hook_count;
439my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 520my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
440 521
441sub verbose { 522sub verbose {
442 my ($level, $msg) = @_; 523 my ($level, $msg) = @_;
443 warn "$msg\n" if $level <= $verbosity; 524 warn "$msg\n" if $level <= $verbosity;
444} 525}
445 526
446# find on_xxx subs in the package and register them
447# as hooks
448sub register_package($) {
449 my ($pkg) = @_;
450
451 for my $htype (0.. $#HOOKNAME) {
452 my $name = $HOOKNAME[$htype];
453
454 my $ref = $pkg->can ("on_" . lc $name)
455 or next;
456
457 $TERM->{_hook}[$htype]{$pkg} = $ref;
458 $hook_count[$htype]++
459 or set_should_invoke $htype, 1;
460 }
461}
462
463my $extension_pkg = "extension0000"; 527my $extension_pkg = "extension0000";
464my %extension_pkg; 528my %extension_pkg;
465 529
466# load a single script into its own package, once only 530# load a single script into its own package, once only
467sub extension_package($) { 531sub extension_package($) {
473 verbose 3, "loading extension '$path' into package '$pkg'"; 537 verbose 3, "loading extension '$path' into package '$pkg'";
474 538
475 open my $fh, "<:raw", $path 539 open my $fh, "<:raw", $path
476 or die "$path: $!"; 540 or die "$path: $!";
477 541
542 my $source = untaint
478 my $source = untaint "package $pkg; use strict; use utf8;\n" 543 "package $pkg; use strict; use utf8;\n"
479 . "use base urxvt::term::proxy::;\n" 544 . "use base urxvt::term::extension::;\n"
480 . "#line 1 \"$path\"\n{\n" 545 . "#line 1 \"$path\"\n{\n"
481 . (do { local $/; <$fh> }) 546 . (do { local $/; <$fh> })
482 . "\n};\n1"; 547 . "\n};\n1";
483 548
549 eval $source
484 eval $source or die "$path: $@"; 550 or die "$path: $@";
485 551
486 $pkg 552 $pkg
487 } 553 }
488} 554}
489 555
495 my $htype = shift; 561 my $htype = shift;
496 562
497 if ($htype == 0) { # INIT 563 if ($htype == 0) { # INIT
498 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 564 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
499 565
500 my %want_ext; 566 my %ext_arg;
501 567
502 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 568 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
503 if ($_ eq "default") { 569 if ($_ eq "default") {
504 $want_ext{$_}++ for qw(selection option-popup selection-popup); 570 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
505 } elsif (/^-(.*)$/) { 571 } elsif (/^-(.*)$/) {
506 delete $want_ext{$1}; 572 delete $ext_arg{$1};
573 } elsif (/^([^<]+)<(.*)>$/) {
574 push @{ $ext_arg{$1} }, $2;
507 } else { 575 } else {
508 $want_ext{$_}++; 576 $ext_arg{$_} ||= [];
509 } 577 }
510 } 578 }
511 579
512 for my $ext (keys %want_ext) { 580 while (my ($ext, $argv) = each %ext_arg) {
513 my @files = grep -f $_, map "$_/$ext", @dirs; 581 my @files = grep -f $_, map "$_/$ext", @dirs;
514 582
515 if (@files) { 583 if (@files) {
516 register_package extension_package $files[0]; 584 $TERM->register_package (extension_package $files[0], $argv);
517 } else { 585 } else {
518 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";
519 } 587 }
520 } 588 }
521 589
530 if $verbosity >= 10; 598 if $verbosity >= 10;
531 599
532 keys %$cb; 600 keys %$cb;
533 601
534 while (my ($pkg, $cb) = each %$cb) { 602 while (my ($pkg, $cb) = each %$cb) {
535 eval { 603 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
536 $retval = $cb->(
537 $TERM->{_pkg}{$pkg} ||= do {
538 my $proxy = bless { }, $pkg;
539 Scalar::Util::weaken ($proxy->{term} = $TERM);
540 $proxy
541 },
542 @_,
543 ) and last; 604 and last;
544 }; 605
545 if ($@) { 606 if ($@) {
546 $TERM->ungrab; # better to lose the grab than the session 607 $TERM->ungrab; # better to lose the grab than the session
547 warn $@; 608 warn $@;
548 } 609 }
549 } 610 }
611
612 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
613 if $verbosity >= 11;
550 } 614 }
551 615
552 if ($htype == 1) { # DESTROY 616 if ($htype == 1) { # DESTROY
553 # remove hooks if unused
554 if (my $hook = $TERM->{_hook}) { 617 if (my $hook = delete $TERM->{_hook}) {
555 for my $htype (0..$#$hook) { 618 for my $htype (0..$#$hook) {
556 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } 619 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
557 or set_should_invoke $htype, 0; 620 or set_should_invoke $htype, 0;
558 } 621 }
559 } 622 }
566 } 629 }
567 630
568 $retval 631 $retval
569} 632}
570 633
571# urxvt::term::proxy 634sub exec_async(@) {
635 my $pid = fork;
572 636
573sub urxvt::term::proxy::AUTOLOAD { 637 return
574 $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 =~ /:([^:]+)$/
575 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 688 or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
576 689
577 eval qq{ 690 eval qq{
578 sub $urxvt::term::proxy::AUTOLOAD { 691 sub $AUTOLOAD {
579 my \$proxy = shift; 692 my \$proxy = shift;
580 \$proxy->{term}->$1 (\@_) 693 \$proxy->{term}->$1 (\@_)
581 } 694 }
582 1 695 1
583 } or die "FATAL: unable to compile method forwarder: $@"; 696 } or die "FATAL: unable to compile method forwarder: $@";
584 697
585 goto &$urxvt::term::proxy::AUTOLOAD; 698 goto &$AUTOLOAD;
586} 699}
587 700
588sub urxvt::term::proxy::DESTROY { 701sub DESTROY {
589 # nop 702 # nop
590} 703}
591 704
592# urxvt::destroy_hook 705# urxvt::destroy_hook
593 706
603 716
604=head2 The C<urxvt::anyevent> Class 717=head2 The C<urxvt::anyevent> Class
605 718
606The 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
607C<AnyEvent> module - any module using it will work inside urxvt without 720C<AnyEvent> module - any module using it will work inside urxvt without
608further work. The only exception is that you cannot wait on condition 721further programming. The only exception is that you cannot wait on
609variables, 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
610cannot use blocking APIs, but the non-blocking variant should work. 723is that you cannot use blocking APIs, but the non-blocking variant should
724work.
611 725
612=cut 726=cut
613 727
614our $VERSION = 1; 728our $VERSION = 1;
615 729
660 ${$_[0]}++; 774 ${$_[0]}++;
661} 775}
662 776
663sub urxvt::anyevent::condvar::wait { 777sub urxvt::anyevent::condvar::wait {
664 unless (${$_[0]}) { 778 unless (${$_[0]}) {
665 require Carp;
666 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";
667 } 780 }
668} 781}
669 782
670package urxvt::term; 783package urxvt::term;
671 784
672=head2 The C<urxvt::term> Class 785=head2 The C<urxvt::term> Class
673 786
674=over 4 787=over 4
675 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
676=item $term->destroy 830=item $term->destroy
677 831
678Destroy 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.
679 835
680=item $isset = $term->option ($optval[, $set]) 836=item $isset = $term->option ($optval[, $set])
681 837
682Returns true if the option specified by C<$optval> is enabled, and 838Returns true if the option specified by C<$optval> is enabled, and
683optionally 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
733 my ($self, $name) = (shift, shift); 889 my ($self, $name) = (shift, shift);
734 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 890 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
735 &urxvt::term::_resource 891 &urxvt::term::_resource
736} 892}
737 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
738=item $rend = $term->rstyle ([$new_rstyle]) 910=item $rend = $term->rstyle ([$new_rstyle])
739 911
740Return and optionally change the current rendition. Text that is output by 912Return and optionally change the current rendition. Text that is output by
741the terminal application will use this style. 913the terminal application will use this style.
742 914
752=item ($row, $col) = $term->selection_end ([$row, $col]) 924=item ($row, $col) = $term->selection_end ([$row, $col])
753 925
754Return the current values of the selection mark, begin or end positions, 926Return the current values of the selection mark, begin or end positions,
755and optionally set them to new values. 927and optionally set them to new values.
756 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
757=item $success = $term->selection_grab ($eventtime) 936=item $success = $term->selection_grab ($eventtime)
758 937
759Try 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
760by 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.
761 941
762=item $oldtext = $term->selection ([$newtext]) 942=item $oldtext = $term->selection ([$newtext])
763 943
764Return the current selection text and optionally replace it by C<$newtext>. 944Return the current selection text and optionally replace it by C<$newtext>.
765 945
766#=item $term->overlay ($x, $y, $text) 946=item $term->overlay_simple ($x, $y, $text)
767# 947
768#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.
769# 949
770#=cut 950=cut
771# 951
772#sub urxvt::term::scr_overlay { 952sub overlay_simple {
773# my ($self, $x, $y, $text) = @_; 953 my ($self, $x, $y, $text) = @_;
774# 954
775# my @lines = split /\n/, $text; 955 my @lines = split /\n/, $text;
776# 956
777# my $w = 0; 957 my $w = List::Util::max map $self->strwidth ($_), @lines;
778# for (map $self->strwidth ($_), @lines) { 958
779# $w = $_ if $w < $_;
780# }
781#
782# $self->scr_overlay_new ($x, $y, $w, scalar @lines); 959 my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
783# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; 960 $overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
784#} 961
962 $overlay
963}
785 964
786=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) 965=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
787 966
788Create a new (empty) overlay at the given position with the given 967Create a new (empty) overlay at the given position with the given
789width/height. C<$rstyle> defines the initial rendition style 968width/height. C<$rstyle> defines the initial rendition style
856 1035
857=item $string = $term->locale_decode ($octets) 1036=item $string = $term->locale_decode ($octets)
858 1037
859Convert the given locale-encoded octets into a perl string. 1038Convert the given locale-encoded octets into a perl string.
860 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
861=item $term->scr_add_lines ($string) 1057=item $term->scr_add_lines ($string)
862 1058
863Write 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
864running inside the terminal. It may not contain command sequences (escape 1060running inside the terminal. It may not contain command sequences (escape
865codes), 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
879 1075
880Write 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
881pass characters instead of octets, you should convert your strings first 1077pass characters instead of octets, you should convert your strings first
882to the locale-specific encoding using C<< $term->locale_encode >>. 1078to the locale-specific encoding using C<< $term->locale_encode >>.
883 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
884=item $windowid = $term->parent 1087=item $windowid = $term->parent
885 1088
886Return the window id of the toplevel window. 1089Return the window id of the toplevel window.
887 1090
888=item $windowid = $term->vt 1091=item $windowid = $term->vt
912=item $nrow_plus_saveLines = $term->total_rows 1115=item $nrow_plus_saveLines = $term->total_rows
913 1116
914=item $lines_in_scrollback = $term->nsaved 1117=item $lines_in_scrollback = $term->nsaved
915 1118
916Return 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}
917 1143
918=item $modifiermask = $term->ModLevel3Mask 1144=item $modifiermask = $term->ModLevel3Mask
919 1145
920=item $modifiermask = $term->ModMetaMask 1146=item $modifiermask = $term->ModMetaMask
921 1147
1014Return 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.
1015 1241
1016=item $offset = $line->offset_of ($row, $col) 1242=item $offset = $line->offset_of ($row, $col)
1017 1243
1018Returns 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
1019line. 1245line. Works for rows outside the line, too, and returns corresponding
1246offsets outside the string.
1020 1247
1021=item ($row, $col) = $line->coord_of ($offset) 1248=item ($row, $col) = $line->coord_of ($offset)
1022 1249
1023Translates a string offset into terminal coordinates again. 1250Translates a string offset into terminal coordinates again.
1024 1251
1098 $offset / $self->{ncol} + $self->{beg}, 1325 $offset / $self->{ncol} + $self->{beg},
1099 $offset % $self->{ncol} 1326 $offset % $self->{ncol}
1100 ) 1327 )
1101} 1328}
1102 1329
1103=item ($row, $col) = $line->coord_of ($offset)
1104=item $text = $term->special_encode $string 1330=item $text = $term->special_encode $string
1105 1331
1106Converts a perl string into the special encoding used by rxvt-unicode, 1332Converts a perl string into the special encoding used by rxvt-unicode,
1107where one character corresponds to one screen cell. See 1333where one character corresponds to one screen cell. See
1108C<< $term->ROW_t >> for details. 1334C<< $term->ROW_t >> for details.
1110=item $string = $term->special_decode $text 1336=item $string = $term->special_decode $text
1111 1337
1112Converts rxvt-unicodes text reprsentation into a perl string. See 1338Converts rxvt-unicodes text reprsentation into a perl string. See
1113C<< $term->ROW_t >> for details. 1339C<< $term->ROW_t >> for details.
1114 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
1115=back 1369=back
1116 1370
1117=cut 1371=cut
1118 1372
1119package urxvt::popup; 1373package urxvt::popup;
1134 $item->{render} ||= sub { $_[0]{text} }; 1388 $item->{render} ||= sub { $_[0]{text} };
1135 1389
1136 push @{ $self->{item} }, $item; 1390 push @{ $self->{item} }, $item;
1137} 1391}
1138 1392
1139sub add_separator { 1393=item $popup->add_title ($title)
1140 my ($self, $sep) = @_;
1141 1394
1142 $sep ||= "═"; 1395Adds a non-clickable title to the popup.
1143 1396
1144 $self->add_item ({ 1397=cut
1145 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1146 text => "",
1147 render => sub { $sep x $urxvt::TERM->ncol },
1148 activate => sub { },
1149 });
1150}
1151 1398
1152sub add_title { 1399sub add_title {
1153 my ($self, $title) = @_; 1400 my ($self, $title) = @_;
1154 1401
1155 $self->add_item ({ 1402 $self->add_item ({
1157 text => $title, 1404 text => $title,
1158 activate => sub { }, 1405 activate => sub { },
1159 }); 1406 });
1160} 1407}
1161 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
1162sub add_button { 1435sub add_button {
1163 my ($self, $text, $cb) = @_; 1436 my ($self, $text, $cb) = @_;
1164 1437
1165 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb}); 1438 $self->add_item ({ type => "button", text => $text, activate => $cb});
1166} 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
1167 1448
1168sub add_toggle { 1449sub add_toggle {
1169 my ($self, $text, $cb, $value) = @_; 1450 my ($self, $text, $cb, $value) = @_;
1170 1451
1171 my $item; $item = { 1452 my $item; $item = {
1172 type => "button", 1453 type => "button",
1173 text => " $text", 1454 text => " $text",
1174 value => $value, 1455 value => $value,
1175 render => sub { ($_[0]{value} ? "* " : " ") . $text }, 1456 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1176 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); }, 1457 activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1177 }; 1458 };
1178 1459
1179 $self->add_item ($item); 1460 $self->add_item ($item);
1180} 1461}
1462
1463=item $popup->show
1464
1465Displays the popup (which is initially hidden).
1466
1467=cut
1181 1468
1182sub show { 1469sub show {
1183 my ($self) = @_; 1470 my ($self) = @_;
1184 1471
1185 local $urxvt::popup::self = $self; 1472 local $urxvt::popup::self = $self;
1186 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"),
1187 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,
1188 "--transient-for" => $self->{term}->parent, 1481 "--transient-for" => $self->{term}->parent,
1482 "-display" => $self->{term}->display_id,
1189 "-pe" => "urxvt-popup") 1483 "-pe" => "urxvt-popup")
1190 or die "unable to create popup window\n"; 1484 or die "unable to create popup window\n";
1191} 1485}
1192 1486
1193sub DESTROY { 1487sub DESTROY {
1194 my ($self) = @_; 1488 my ($self) = @_;
1195 1489
1196 delete $self->{term}{_destroy}{$self}; 1490 delete $self->{term}{_destroy}{$self};
1197 $self->{term}->ungrab; 1491 $self->{term}->ungrab;
1198} 1492}
1493
1494=back
1199 1495
1200=head2 The C<urxvt::timer> Class 1496=head2 The C<urxvt::timer> Class
1201 1497
1202This class implements timer watchers/events. Time is represented as a 1498This class implements timer watchers/events. Time is represented as a
1203fractional number of seconds since the epoch. Example: 1499fractional number of seconds since the epoch. Example:
1256 1552
1257 $term->{socket} = ... 1553 $term->{socket} = ...
1258 $term->{iow} = urxvt::iow 1554 $term->{iow} = urxvt::iow
1259 ->new 1555 ->new
1260 ->fd (fileno $term->{socket}) 1556 ->fd (fileno $term->{socket})
1261 ->events (1) # wait for read data 1557 ->events (urxvt::EVENT_READ)
1262 ->start 1558 ->start
1263 ->cb (sub { 1559 ->cb (sub {
1264 my ($iow, $revents) = @_; 1560 my ($iow, $revents) = @_;
1265 # $revents must be 1 here, no need to check 1561 # $revents must be 1 here, no need to check
1266 sysread $term->{socket}, my $buf, 8192 1562 sysread $term->{socket}, my $buf, 8192
1283 1579
1284Set the filedescriptor (not handle) to watch. 1580Set the filedescriptor (not handle) to watch.
1285 1581
1286=item $iow = $iow->events ($eventmask) 1582=item $iow = $iow->events ($eventmask)
1287 1583
1288Set 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
1289data, 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>.
1290 1587
1291=item $iow = $iow->start 1588=item $iow = $iow->start
1292 1589
1293Start watching for requested events on the given handle. 1590Start watching for requested events on the given handle.
1294 1591
1309 1606
1310=item == 0 - fatal messages 1607=item == 0 - fatal messages
1311 1608
1312=item >= 3 - script loading and management 1609=item >= 3 - script loading and management
1313 1610
1314=item >=10 - all events received 1611=item >=10 - all called hooks
1612
1613=item >=11 - hook reutrn values
1315 1614
1316=back 1615=back
1317 1616
1318=head1 AUTHOR 1617=head1 AUTHOR
1319 1618

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines