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.90 by root, Thu Jan 12 12:15:10 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
49It also offers the following bindable event: 50A double-click usually selects the word under the cursor, further clicks
51will enlarge the selection.
52
53The selection works by trying to match a number of regexes and displaying
54them in increasing order of length. You can add your own regexes by
55specifying resources of the form:
56
57 URxvt.selection.pattern-0: perl-regex
58 URxvt.selection.pattern-1: perl-regex
59 ...
60
61The index number (0, 1...) must not have any holes, and each regex must
62contain at least one pair of capturing parentheses, which will be used for
63the match. For example, the followign adds a regex that matches everything
64between two vertical bars:
65
66 URxvt.selection.pattern-0: \\|([^|]+)\\|
67
68You can look at the source of the selection extension to see more
69interesting uses, such as parsing a line from beginning to end.
70
71This extension also offers the following bindable keyboard command:
50 72
51=over 4 73=over 4
52 74
53=item rot13 75=item rot13
54 76
64runtime. 86runtime.
65 87
66=item selection-popup (enabled by default) 88=item selection-popup (enabled by default)
67 89
68Binds a popup menu to Ctrl-Button3 that lets you convert the selection 90Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69text into various other formats/action. 91text into various other formats/action (such as uri unescaping, perl
92evalution, web-browser starting etc.), depending on content.
70 93
71=item digital-clock 94=item searchable-scrollback<hotkey> (enabled by default)
72 95
73Displays a digital clock using the built-in overlay. 96Adds regex search functionality to the scrollback buffer, triggered
97by a hotkey (default: C<M-s>). While in search mode, normal terminal
98input/output is suspended and a regex is displayed at the bottom of the
99screen.
100
101Inputting characters appends them to the regex and continues incremental
102search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
103search upwards/downwards in the scrollback buffer, C<End> jumps to the
104bottom. C<Escape> leaves search mode and returns to the point where search
105was started, while C<Enter> or C<Return> stay at the current position and
106additionally stores the first match in the current line into the primary
107selection.
108
109=item selection-autotransform
110
111This selection allows you to do automatic transforms on a selection
112whenever a selection is made.
113
114It works by specifying perl snippets (most useful is a single C<s///>
115operator) that modify C<$_> as resources:
116
117 URxvt.selection-autotransform.0: transform
118 URxvt.selection-autotransform.1: transform
119 ...
120
121For example, the following will transform selections of the form
122C<filename:number>, often seen in compiler messages, into C<vi +$filename
123$word>:
124
125 URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126
127And this example matches the same,but replaces it with vi-commands you can
128paste directly into your (vi :) editor:
129
130 URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
131
132Of course, this can be modified to suit your needs and your editor :)
74 133
75=item mark-urls 134=item mark-urls
76 135
77Uses per-line display filtering (C<on_line_update>) to underline urls. 136Uses per-line display filtering (C<on_line_update>) to underline urls and
137make them clickable. When middle-clicked, the program specified in the
138resource C<urlLauncher> (default C<x-www-browser>) will be started with
139the URL as first argument.
78 140
79=item block-graphics-to-ascii 141=item block-graphics-to-ascii
80 142
81A not very useful example of filtering all text output to the terminal, 143A not very useful example of filtering all text output to the terminal,
82by replacing all line-drawing characters (U+2500 .. U+259F) by a 144by replacing all line-drawing characters (U+2500 .. U+259F) by a
83similar-looking ascii character. 145similar-looking ascii character.
84 146
147=item digital-clock
148
149Displays a digital clock using the built-in overlay.
150
85=item example-refresh-hooks 151=item example-refresh-hooks
86 152
87Displays a very simple digital clock in the upper right corner of the 153Displays a very simple digital clock in the upper right corner of the
88window. Illustrates overwriting the refresh callbacks to create your own 154window. Illustrates overwriting the refresh callbacks to create your own
89overlays or changes. 155overlays or changes.
90 156
91=back 157=back
158
159=head1 API DOCUMENTATION
92 160
93=head2 General API Considerations 161=head2 General API Considerations
94 162
95All objects (such as terminals, time watchers etc.) are typical 163All objects (such as terminals, time watchers etc.) are typical
96reference-to-hash objects. The hash can be used to store anything you 164reference-to-hash objects. The hash can be used to store anything you
109=over 4 177=over 4
110 178
111=item $text 179=item $text
112 180
113Rxvt-unicodes special way of encoding text, where one "unicode" character 181Rxvt-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. 182always represents one screen cell. See L<ROW_t> for a discussion of this format.
115 183
116=item $string 184=item $string
117 185
118A perl text string, with an emphasis on I<text>. It can store all unicode 186A 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 187characters and is to be distinguished with text encoded in a specific
124Either binary data or - more common - a text string encoded in a 192Either binary data or - more common - a text string encoded in a
125locale-specific way. 193locale-specific way.
126 194
127=back 195=back
128 196
197=head2 Extension Objects
198
199Very perl extension is a perl class. A separate perl object is created
200for each terminal and each extension and passed as the first parameter to
201hooks. So extensions can use their C<$self> object without having to think
202about other extensions, with the exception of methods and members that
203begin with an underscore character C<_>: these are reserved for internal
204use.
205
206Although it isn't a C<urxvt::term> object, you can call all methods of the
207C<urxvt::term> class on this object.
208
209It has the following methods and data members:
210
211=over 4
212
213=item $urxvt_term = $self->{term}
214
215Returns the C<urxvt::term> object associated with this instance of the
216extension. This member I<must not> be changed in any way.
217
218=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
219
220Dynamically enable the given hooks (named without the C<on_> prefix) for
221this extension, replacing any previous hook. This is useful when you want
222to overwrite time-critical hooks only temporarily.
223
224=item $self->disable ($hook_name[, $hook_name..])
225
226Dynamically disable the given hooks.
227
228=back
229
129=head2 Hooks 230=head2 Hooks
130 231
131The following subroutines can be declared in extension files, and will be 232The following subroutines can be declared in extension files, and will be
132called whenever the relevant event happens. 233called whenever the relevant event happens.
133 234
134The first argument passed to them is an object private to each terminal 235The 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 236the 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 237
141All of them must return a boolean value. If it is true, then the event 238B<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, 239event 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. 240skipped, and the relevant action might not be carried out by the C++ code.
144 241
145When in doubt, return a false value (preferably C<()>). 242I<< When in doubt, return a false value (preferably C<()>). >>
146 243
147=over 4 244=over 4
148 245
149=item on_init $term 246=item on_init $term
150 247
185=item on_sel_extend $term 282=item on_sel_extend $term
186 283
187Called whenever the user tries to extend the selection (e.g. with a double 284Called whenever the user tries to extend the selection (e.g. with a double
188click) and is either supposed to return false (normal operation), or 285click) and is either supposed to return false (normal operation), or
189should extend the selection itelf and return true to suppress the built-in 286should extend the selection itelf and return true to suppress the built-in
190processing. 287processing. This can happen multiple times, as long as the callback
288returns true, it will be called on every further click by the user and is
289supposed to enlarge the selection more and more, if possible.
191 290
192See the F<selection> example extension. 291See the F<selection> example extension.
193 292
194=item on_view_change $term, $offset 293=item on_view_change $term, $offset
195 294
204than the scroll back buffer or the terminal. 303than the scroll back buffer or the terminal.
205 304
206It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 305It 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 306$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
208number of lines that will be in the scrollback buffer. 307number 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 308
214=item on_osc_seq $term, $string 309=item on_osc_seq $term, $string
215 310
216Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 311Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
217operating system command) is processed. Cursor position and other state 312operating system command) is processed. Cursor position and other state
230can filter/change and output the text yourself by returning a true value 325can filter/change and output the text yourself by returning a true value
231and calling C<< $term->scr_add_lines >> yourself. Please note that this 326and 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 327might be very slow, however, as your hook is called for B<all> text being
233output. 328output.
234 329
330=item on_tt_write $term, $octets
331
332Called whenever some data is written to the tty/pty and can be used to
333suppress or filter tty input.
334
235=item on_line_update $term, $row 335=item on_line_update $term, $row
236 336
237Called whenever a line was updated or changed. Can be used to filter 337Called whenever a line was updated or changed. Can be used to filter
238screen output (e.g. underline urls or other useless stuff). Only lines 338screen output (e.g. underline urls or other useless stuff). Only lines
239that are being shown will be filtered, and, due to performance reasons, 339that are being shown will be filtered, and, due to performance reasons,
271=item on_focus_out $term 371=item on_focus_out $term
272 372
273Called wheneever the window loses keyboard focus, before rxvt-unicode does 373Called wheneever the window loses keyboard focus, before rxvt-unicode does
274focus out processing. 374focus out processing.
275 375
276=item on_key_press $term, $event, $octets 376=item on_key_press $term, $event, $keysym, $octets
277 377
278=item on_key_release $term, $event 378=item on_key_release $term, $event, $keysym
279 379
280=item on_button_press $term, $event 380=item on_button_press $term, $event
281 381
282=item on_button_release $term, $event 382=item on_button_release $term, $event
283 383
299 399
300subwindow. 400subwindow.
301 401
302=back 402=back
303 403
404=cut
405
406package urxvt;
407
408use utf8;
409use strict;
410use Carp ();
411use Scalar::Util ();
412use List::Util ();
413
414our $VERSION = 1;
415our $TERM;
416our @HOOKNAME;
417our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
418our %OPTION;
419
420our $LIBDIR;
421our $RESNAME;
422our $RESCLASS;
423our $RXVTNAME;
424
304=head2 Variables in the C<urxvt> Package 425=head2 Variables in the C<urxvt> Package
305 426
306=over 4 427=over 4
428
429=item $urxvt::LIBDIR
430
431The rxvt-unicode library directory, where, among other things, the perl
432modules and scripts are stored.
433
434=item $urxvt::RESCLASS, $urxvt::RESCLASS
435
436The resource class and name rxvt-unicode uses to look up X resources.
437
438=item $urxvt::RXVTNAME
439
440The basename of the installed binaries, usually C<urxvt>.
307 441
308=item $urxvt::TERM 442=item $urxvt::TERM
309 443
310The current terminal. This variable stores the current C<urxvt::term> 444The current terminal. This variable stores the current C<urxvt::term>
311object, whenever a callback/hook is executing. 445object, whenever a callback/hook is executing.
313=back 447=back
314 448
315=head2 Functions in the C<urxvt> Package 449=head2 Functions in the C<urxvt> Package
316 450
317=over 4 451=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 452
327=item urxvt::fatal $errormessage 453=item urxvt::fatal $errormessage
328 454
329Fatally aborts execution with the given error message. Avoid at all 455Fatally aborts execution with the given error message. Avoid at all
330costs! The only time this is acceptable is when the terminal process 456costs! The only time this is acceptable is when the terminal process
336newline. The module also overwrites the C<warn> builtin with a function 462newline. The module also overwrites the C<warn> builtin with a function
337that calls this function. 463that calls this function.
338 464
339Using this function has the advantage that its output ends up in the 465Using this function has the advantage that its output ends up in the
340correct place, e.g. on stderr of the connecting urxvtc client. 466correct place, e.g. on stderr of the connecting urxvtc client.
467
468Messages have a size limit of 1023 bytes currently.
469
470=item $is_safe = urxvt::safe
471
472Returns true when it is safe to do potentially unsafe things, such as
473evaluating perl code specified by the user. This is true when urxvt was
474started setuid or setgid.
341 475
342=item $time = urxvt::NOW 476=item $time = urxvt::NOW
343 477
344Returns the "current time" (as per the event loop). 478Returns the "current time" (as per the event loop).
345 479
384 518
385=item $background = urxvt::GET_BASEBG $rend 519=item $background = urxvt::GET_BASEBG $rend
386 520
387Return the foreground/background colour index, respectively. 521Return the foreground/background colour index, respectively.
388 522
389=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) 523=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
390 524
391=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) 525=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
392 526
393Replace the foreground/background colour in the rendition mask with the 527Replace the foreground/background colour in the rendition mask with the
394specified one. 528specified one.
395 529
396=item $value = urxvt::GET_CUSTOM ($rend) 530=item $value = urxvt::GET_CUSTOM $rend
397 531
398Return the "custom" value: Every rendition has 5 bits for use by 532Return the "custom" value: Every rendition has 5 bits for use by
399extensions. They can be set and changed as you like and are initially 533extensions. They can be set and changed as you like and are initially
400zero. 534zero.
401 535
402=item $rend = urxvt::SET_CUSTOM ($rend, $new_value) 536=item $rend = urxvt::SET_CUSTOM $rend, $new_value
403 537
404Change the custom value. 538Change the custom value.
405 539
406=back 540=back
407 541
408=cut 542=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 543
423BEGIN { 544BEGIN {
424 urxvt->bootstrap; 545 urxvt->bootstrap;
425 546
426 # overwrite perl's warn 547 # overwrite perl's warn
429 $msg .= "\n" 550 $msg .= "\n"
430 unless $msg =~ /\n$/; 551 unless $msg =~ /\n$/;
431 urxvt::warn ($msg); 552 urxvt::warn ($msg);
432 }; 553 };
433 554
555 # %ENV is the original startup environment
556 delete $ENV{IFS};
557 delete $ENV{CDPATH};
558 delete $ENV{BASH_ENV};
434 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; 559 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
435 delete $ENV{CDPATH};
436} 560}
437 561
438my @hook_count; 562my @hook_count;
439my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 563my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
440 564
441sub verbose { 565sub verbose {
442 my ($level, $msg) = @_; 566 my ($level, $msg) = @_;
443 warn "$msg\n" if $level <= $verbosity; 567 warn "$msg\n" if $level <= $verbosity;
444} 568}
445 569
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"; 570my $extension_pkg = "extension0000";
464my %extension_pkg; 571my %extension_pkg;
465 572
466# load a single script into its own package, once only 573# load a single script into its own package, once only
467sub extension_package($) { 574sub extension_package($) {
473 verbose 3, "loading extension '$path' into package '$pkg'"; 580 verbose 3, "loading extension '$path' into package '$pkg'";
474 581
475 open my $fh, "<:raw", $path 582 open my $fh, "<:raw", $path
476 or die "$path: $!"; 583 or die "$path: $!";
477 584
585 my $source = untaint
478 my $source = untaint "package $pkg; use strict; use utf8;\n" 586 "package $pkg; use strict; use utf8;\n"
479 . "use base urxvt::term::proxy::;\n" 587 . "use base urxvt::term::extension::;\n"
480 . "#line 1 \"$path\"\n{\n" 588 . "#line 1 \"$path\"\n{\n"
481 . (do { local $/; <$fh> }) 589 . (do { local $/; <$fh> })
482 . "\n};\n1"; 590 . "\n};\n1";
483 591
592 eval $source
484 eval $source or die "$path: $@"; 593 or die "$path: $@";
485 594
486 $pkg 595 $pkg
487 } 596 }
488} 597}
489 598
495 my $htype = shift; 604 my $htype = shift;
496 605
497 if ($htype == 0) { # INIT 606 if ($htype == 0) { # INIT
498 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 607 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
499 608
500 my %want_ext; 609 my %ext_arg;
501 610
502 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 611 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
503 if ($_ eq "default") { 612 if ($_ eq "default") {
504 $want_ext{$_}++ for qw(selection option-popup selection-popup); 613 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
505 } elsif (/^-(.*)$/) { 614 } elsif (/^-(.*)$/) {
506 delete $want_ext{$1}; 615 delete $ext_arg{$1};
616 } elsif (/^([^<]+)<(.*)>$/) {
617 push @{ $ext_arg{$1} }, $2;
507 } else { 618 } else {
508 $want_ext{$_}++; 619 $ext_arg{$_} ||= [];
509 } 620 }
510 } 621 }
511 622
512 for my $ext (keys %want_ext) { 623 while (my ($ext, $argv) = each %ext_arg) {
513 my @files = grep -f $_, map "$_/$ext", @dirs; 624 my @files = grep -f $_, map "$_/$ext", @dirs;
514 625
515 if (@files) { 626 if (@files) {
516 register_package extension_package $files[0]; 627 $TERM->register_package (extension_package $files[0], $argv);
517 } else { 628 } else {
518 warn "perl extension '$ext' not found in perl library search path\n"; 629 warn "perl extension '$ext' not found in perl library search path\n";
519 } 630 }
520 } 631 }
521 632
530 if $verbosity >= 10; 641 if $verbosity >= 10;
531 642
532 keys %$cb; 643 keys %$cb;
533 644
534 while (my ($pkg, $cb) = each %$cb) { 645 while (my ($pkg, $cb) = each %$cb) {
535 eval { 646 $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; 647 and last;
544 }; 648
545 if ($@) { 649 if ($@) {
546 $TERM->ungrab; # better to lose the grab than the session 650 $TERM->ungrab; # better to lose the grab than the session
547 warn $@; 651 warn $@;
548 } 652 }
549 } 653 }
654
655 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
656 if $verbosity >= 11;
550 } 657 }
551 658
552 if ($htype == 1) { # DESTROY 659 if ($htype == 1) { # DESTROY
553 # remove hooks if unused
554 if (my $hook = $TERM->{_hook}) { 660 if (my $hook = delete $TERM->{_hook}) {
555 for my $htype (0..$#$hook) { 661 for my $htype (0..$#$hook) {
556 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } 662 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
557 or set_should_invoke $htype, 0; 663 or set_should_invoke $htype, 0;
558 } 664 }
559 } 665 }
566 } 672 }
567 673
568 $retval 674 $retval
569} 675}
570 676
571# urxvt::term::proxy 677sub exec_async(@) {
678 my $pid = fork;
572 679
573sub urxvt::term::proxy::AUTOLOAD { 680 return
574 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 681 if !defined $pid or $pid;
682
683 %ENV = %{ $TERM->env };
684
685 exec @_;
686 _exit 255;
687}
688
689# urxvt::term::extension
690
691package urxvt::term::extension;
692
693sub enable {
694 my ($self, %hook) = @_;
695 my $pkg = $self->{_pkg};
696
697 while (my ($name, $cb) = each %hook) {
698 my $htype = $HOOKTYPE{uc $name};
699 defined $htype
700 or Carp::croak "unsupported hook type '$name'";
701
702 unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
703 $hook_count[$htype]++
704 or urxvt::set_should_invoke $htype, 1;
705 }
706
707 $self->{term}{_hook}[$htype]{$pkg} = $cb;
708 }
709}
710
711sub disable {
712 my ($self, @hook) = @_;
713 my $pkg = $self->{_pkg};
714
715 for my $name (@hook) {
716 my $htype = $HOOKTYPE{uc $name};
717 defined $htype
718 or Carp::croak "unsupported hook type '$name'";
719
720 if (delete $self->{term}{_hook}[$htype]{$pkg}) {
721 --$hook_count[$htype]
722 or urxvt::set_should_invoke $htype, 0;
723 }
724 }
725}
726
727our $AUTOLOAD;
728
729sub AUTOLOAD {
730 $AUTOLOAD =~ /:([^:]+)$/
575 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 731 or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
576 732
577 eval qq{ 733 eval qq{
578 sub $urxvt::term::proxy::AUTOLOAD { 734 sub $AUTOLOAD {
579 my \$proxy = shift; 735 my \$proxy = shift;
580 \$proxy->{term}->$1 (\@_) 736 \$proxy->{term}->$1 (\@_)
581 } 737 }
582 1 738 1
583 } or die "FATAL: unable to compile method forwarder: $@"; 739 } or die "FATAL: unable to compile method forwarder: $@";
584 740
585 goto &$urxvt::term::proxy::AUTOLOAD; 741 goto &$AUTOLOAD;
586} 742}
587 743
588sub urxvt::term::proxy::DESTROY { 744sub DESTROY {
589 # nop 745 # nop
590} 746}
591 747
592# urxvt::destroy_hook 748# urxvt::destroy_hook
593 749
603 759
604=head2 The C<urxvt::anyevent> Class 760=head2 The C<urxvt::anyevent> Class
605 761
606The sole purpose of this class is to deliver an interface to the 762The sole purpose of this class is to deliver an interface to the
607C<AnyEvent> module - any module using it will work inside urxvt without 763C<AnyEvent> module - any module using it will work inside urxvt without
608further work. The only exception is that you cannot wait on condition 764further programming. The only exception is that you cannot wait on
609variables, but non-blocking condvar use is ok. What this means is that you 765condition variables, but non-blocking condvar use is ok. What this means
610cannot use blocking APIs, but the non-blocking variant should work. 766is that you cannot use blocking APIs, but the non-blocking variant should
767work.
611 768
612=cut 769=cut
613 770
614our $VERSION = 1; 771our $VERSION = 1;
615 772
660 ${$_[0]}++; 817 ${$_[0]}++;
661} 818}
662 819
663sub urxvt::anyevent::condvar::wait { 820sub urxvt::anyevent::condvar::wait {
664 unless (${$_[0]}) { 821 unless (${$_[0]}) {
665 require Carp;
666 Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"); 822 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
667 } 823 }
668} 824}
669 825
670package urxvt::term; 826package urxvt::term;
671 827
672=head2 The C<urxvt::term> Class 828=head2 The C<urxvt::term> Class
673 829
674=over 4 830=over 4
675 831
832=cut
833
834# find on_xxx subs in the package and register them
835# as hooks
836sub register_package {
837 my ($self, $pkg, $argv) = @_;
838
839 my $proxy = bless {
840 _pkg => $pkg,
841 argv => $argv,
842 }, $pkg;
843 Scalar::Util::weaken ($proxy->{term} = $self);
844
845 $self->{_pkg}{$pkg} = $proxy;
846
847 for my $name (@HOOKNAME) {
848 if (my $ref = $pkg->can ("on_" . lc $name)) {
849 $proxy->enable ($name => $ref);
850 }
851 }
852}
853
854=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
855
856Creates a new terminal, very similar as if you had started it with system
857C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
858hash which defines the environment of the new terminal.
859
860Croaks (and probably outputs an error message) if the new instance
861couldn't be created. Returns C<undef> if the new instance didn't
862initialise perl, and the terminal object otherwise. The C<init> and
863C<start> hooks will be called during this call.
864
865=cut
866
867sub new {
868 my ($class, $env, @args) = @_;
869
870 _new ([ map "$_=$env->{$_}", keys %$env ], @args);
871}
872
676=item $term->destroy 873=item $term->destroy
677 874
678Destroy the terminal object (close the window, free resources etc.). 875Destroy the terminal object (close the window, free resources
876etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
877watchers (timers, io watchers) are still active.
679 878
680=item $isset = $term->option ($optval[, $set]) 879=item $isset = $term->option ($optval[, $set])
681 880
682Returns true if the option specified by C<$optval> is enabled, and 881Returns true if the option specified by C<$optval> is enabled, and
683optionally change it. All option values are stored by name in the hash 882optionally change it. All option values are stored by name in the hash
733 my ($self, $name) = (shift, shift); 932 my ($self, $name) = (shift, shift);
734 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 933 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
735 &urxvt::term::_resource 934 &urxvt::term::_resource
736} 935}
737 936
937=item $value = $term->x_resource ($pattern)
938
939Returns the X-Resource for the given pattern, excluding the program or
940class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
941same value as used by this instance of rxvt-unicode. Returns C<undef> if no
942resource with that pattern exists.
943
944This method should only be called during the C<on_start> hook, as there is
945only one resource database per display, and later invocations might return
946the wrong resources.
947
948=item $success = $term->parse_keysym ($keysym_spec, $command_string)
949
950Adds a keymap translation exactly as specified via a resource. See the
951C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
952
738=item $rend = $term->rstyle ([$new_rstyle]) 953=item $rend = $term->rstyle ([$new_rstyle])
739 954
740Return and optionally change the current rendition. Text that is output by 955Return and optionally change the current rendition. Text that is output by
741the terminal application will use this style. 956the terminal application will use this style.
742 957
752=item ($row, $col) = $term->selection_end ([$row, $col]) 967=item ($row, $col) = $term->selection_end ([$row, $col])
753 968
754Return the current values of the selection mark, begin or end positions, 969Return the current values of the selection mark, begin or end positions,
755and optionally set them to new values. 970and optionally set them to new values.
756 971
972=item $term->selection_make ($eventtime[, $rectangular])
973
974Tries to make a selection as set by C<selection_beg> and
975C<selection_end>. If C<$rectangular> is true (default: false), a
976rectangular selection will be made. This is the prefered function to make
977a selection.
978
757=item $success = $term->selection_grab ($eventtime) 979=item $success = $term->selection_grab ($eventtime)
758 980
759Try to request the primary selection from the server (for example, as set 981Try to request the primary selection text from the server (for example, as
760by the next method). 982set by the next method). No visual feedback will be given. This function
983is mostly useful from within C<on_sel_grab> hooks.
761 984
762=item $oldtext = $term->selection ([$newtext]) 985=item $oldtext = $term->selection ([$newtext])
763 986
764Return the current selection text and optionally replace it by C<$newtext>. 987Return the current selection text and optionally replace it by C<$newtext>.
765 988
766#=item $term->overlay ($x, $y, $text) 989=item $term->overlay_simple ($x, $y, $text)
767# 990
768#Create a simple multi-line overlay box. See the next method for details. 991Create a simple multi-line overlay box. See the next method for details.
769# 992
770#=cut 993=cut
771# 994
772#sub urxvt::term::scr_overlay { 995sub overlay_simple {
773# my ($self, $x, $y, $text) = @_; 996 my ($self, $x, $y, $text) = @_;
774# 997
775# my @lines = split /\n/, $text; 998 my @lines = split /\n/, $text;
776# 999
777# my $w = 0; 1000 my $w = List::Util::max map $self->strwidth ($_), @lines;
778# for (map $self->strwidth ($_), @lines) { 1001
779# $w = $_ if $w < $_;
780# }
781#
782# $self->scr_overlay_new ($x, $y, $w, scalar @lines); 1002 my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
783# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; 1003 $overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
784#} 1004
1005 $overlay
1006}
785 1007
786=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) 1008=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
787 1009
788Create a new (empty) overlay at the given position with the given 1010Create a new (empty) overlay at the given position with the given
789width/height. C<$rstyle> defines the initial rendition style 1011width/height. C<$rstyle> defines the initial rendition style
856 1078
857=item $string = $term->locale_decode ($octets) 1079=item $string = $term->locale_decode ($octets)
858 1080
859Convert the given locale-encoded octets into a perl string. 1081Convert the given locale-encoded octets into a perl string.
860 1082
1083=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1084
1085XORs the rendition values in the given span with the provided value
1086(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
1087refresh hooks to provide effects similar to the selection.
1088
1089=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1090
1091Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1092whitespace will additionally be xored with the C<$rstyle2>, which defaults
1093to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1094it instead. Both styles I<MUST NOT> contain font styles.
1095
1096=item $term->scr_bell
1097
1098Ring the bell!
1099
861=item $term->scr_add_lines ($string) 1100=item $term->scr_add_lines ($string)
862 1101
863Write the given text string to the screen, as if output by the application 1102Write the given text string to the screen, as if output by the application
864running inside the terminal. It may not contain command sequences (escape 1103running inside the terminal. It may not contain command sequences (escape
865codes), but is free to use line feeds, carriage returns and tabs. The 1104codes), but is free to use line feeds, carriage returns and tabs. The
879 1118
880Write the octets given in C<$data> to the tty (i.e. as program input). To 1119Write 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 1120pass characters instead of octets, you should convert your strings first
882to the locale-specific encoding using C<< $term->locale_encode >>. 1121to the locale-specific encoding using C<< $term->locale_encode >>.
883 1122
1123=item $old_events = $term->pty_ev_events ([$new_events])
1124
1125Replaces the event mask of the pty watcher by the given event mask. Can
1126be used to suppress input and output handling to the pty/tty. See the
1127description of C<< urxvt::timer->events >>. Make sure to always restore
1128the previous value.
1129
884=item $windowid = $term->parent 1130=item $windowid = $term->parent
885 1131
886Return the window id of the toplevel window. 1132Return the window id of the toplevel window.
887 1133
888=item $windowid = $term->vt 1134=item $windowid = $term->vt
912=item $nrow_plus_saveLines = $term->total_rows 1158=item $nrow_plus_saveLines = $term->total_rows
913 1159
914=item $lines_in_scrollback = $term->nsaved 1160=item $lines_in_scrollback = $term->nsaved
915 1161
916Return various integers describing terminal characteristics. 1162Return various integers describing terminal characteristics.
1163
1164=item $x_display = $term->display_id
1165
1166Return the DISPLAY used by rxvt-unicode.
1167
1168=item $lc_ctype = $term->locale
1169
1170Returns the LC_CTYPE category string used by this rxvt-unicode.
1171
1172=item $env = $term->env
1173
1174Returns a copy of the environment in effect for the terminal as a hashref
1175similar to C<\%ENV>.
1176
1177=cut
1178
1179sub env {
1180 if (my $env = $_[0]->_env) {
1181 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
1182 } else {
1183 +{ %ENV }
1184 }
1185}
917 1186
918=item $modifiermask = $term->ModLevel3Mask 1187=item $modifiermask = $term->ModLevel3Mask
919 1188
920=item $modifiermask = $term->ModMetaMask 1189=item $modifiermask = $term->ModMetaMask
921 1190
1014Return the row number of the first/last row of the line, respectively. 1283Return the row number of the first/last row of the line, respectively.
1015 1284
1016=item $offset = $line->offset_of ($row, $col) 1285=item $offset = $line->offset_of ($row, $col)
1017 1286
1018Returns the character offset of the given row|col pair within the logical 1287Returns the character offset of the given row|col pair within the logical
1019line. 1288line. Works for rows outside the line, too, and returns corresponding
1289offsets outside the string.
1020 1290
1021=item ($row, $col) = $line->coord_of ($offset) 1291=item ($row, $col) = $line->coord_of ($offset)
1022 1292
1023Translates a string offset into terminal coordinates again. 1293Translates a string offset into terminal coordinates again.
1024 1294
1098 $offset / $self->{ncol} + $self->{beg}, 1368 $offset / $self->{ncol} + $self->{beg},
1099 $offset % $self->{ncol} 1369 $offset % $self->{ncol}
1100 ) 1370 )
1101} 1371}
1102 1372
1103=item ($row, $col) = $line->coord_of ($offset)
1104=item $text = $term->special_encode $string 1373=item $text = $term->special_encode $string
1105 1374
1106Converts a perl string into the special encoding used by rxvt-unicode, 1375Converts a perl string into the special encoding used by rxvt-unicode,
1107where one character corresponds to one screen cell. See 1376where one character corresponds to one screen cell. See
1108C<< $term->ROW_t >> for details. 1377C<< $term->ROW_t >> for details.
1110=item $string = $term->special_decode $text 1379=item $string = $term->special_decode $text
1111 1380
1112Converts rxvt-unicodes text reprsentation into a perl string. See 1381Converts rxvt-unicodes text reprsentation into a perl string. See
1113C<< $term->ROW_t >> for details. 1382C<< $term->ROW_t >> for details.
1114 1383
1384=item $success = $term->grab_button ($button, $modifiermask)
1385
1386Registers a synchronous button grab. See the XGrabButton manpage.
1387
1388=item $success = $term->grab ($eventtime[, $sync])
1389
1390Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1391synchronous (C<$sync> is true). Also remembers the grab timestampe.
1392
1393=item $term->allow_events_async
1394
1395Calls XAllowEvents with AsyncBoth for the most recent grab.
1396
1397=item $term->allow_events_sync
1398
1399Calls XAllowEvents with SyncBoth for the most recent grab.
1400
1401=item $term->allow_events_replay
1402
1403Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1404recent grab.
1405
1406=item $term->ungrab
1407
1408Calls XUngrab for the most recent grab. Is called automatically on
1409evaluation errors, as it is better to lose the grab in the error case as
1410the session.
1411
1115=back 1412=back
1116 1413
1117=cut 1414=cut
1118 1415
1119package urxvt::popup; 1416package urxvt::popup;
1134 $item->{render} ||= sub { $_[0]{text} }; 1431 $item->{render} ||= sub { $_[0]{text} };
1135 1432
1136 push @{ $self->{item} }, $item; 1433 push @{ $self->{item} }, $item;
1137} 1434}
1138 1435
1139sub add_separator { 1436=item $popup->add_title ($title)
1140 my ($self, $sep) = @_;
1141 1437
1142 $sep ||= "═"; 1438Adds a non-clickable title to the popup.
1143 1439
1144 $self->add_item ({ 1440=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 1441
1152sub add_title { 1442sub add_title {
1153 my ($self, $title) = @_; 1443 my ($self, $title) = @_;
1154 1444
1155 $self->add_item ({ 1445 $self->add_item ({
1157 text => $title, 1447 text => $title,
1158 activate => sub { }, 1448 activate => sub { },
1159 }); 1449 });
1160} 1450}
1161 1451
1452=item $popup->add_separator ([$sepchr])
1453
1454Creates a separator, optionally using the character given as C<$sepchr>.
1455
1456=cut
1457
1458sub add_separator {
1459 my ($self, $sep) = @_;
1460
1461 $sep ||= "=";
1462
1463 $self->add_item ({
1464 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1465 text => "",
1466 render => sub { $sep x $self->{term}->ncol },
1467 activate => sub { },
1468 });
1469}
1470
1471=item $popup->add_button ($text, $cb)
1472
1473Adds a clickable button to the popup. C<$cb> is called whenever it is
1474selected.
1475
1476=cut
1477
1162sub add_button { 1478sub add_button {
1163 my ($self, $text, $cb) = @_; 1479 my ($self, $text, $cb) = @_;
1164 1480
1165 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb}); 1481 $self->add_item ({ type => "button", text => $text, activate => $cb});
1166} 1482}
1483
1484=item $popup->add_toggle ($text, $cb, $initial_value)
1485
1486Adds a toggle/checkbox item to the popup. Teh callback gets called
1487whenever it gets toggled, with a boolean indicating its value as its first
1488argument.
1489
1490=cut
1167 1491
1168sub add_toggle { 1492sub add_toggle {
1169 my ($self, $text, $cb, $value) = @_; 1493 my ($self, $text, $cb, $value) = @_;
1170 1494
1171 my $item; $item = { 1495 my $item; $item = {
1172 type => "button", 1496 type => "button",
1173 text => " $text", 1497 text => " $text",
1174 value => $value, 1498 value => $value,
1175 render => sub { ($_[0]{value} ? "* " : " ") . $text }, 1499 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1176 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); }, 1500 activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1177 }; 1501 };
1178 1502
1179 $self->add_item ($item); 1503 $self->add_item ($item);
1180} 1504}
1505
1506=item $popup->show
1507
1508Displays the popup (which is initially hidden).
1509
1510=cut
1181 1511
1182sub show { 1512sub show {
1183 my ($self) = @_; 1513 my ($self) = @_;
1184 1514
1185 local $urxvt::popup::self = $self; 1515 local $urxvt::popup::self = $self;
1186 1516
1517 my $env = $self->{term}->env;
1518 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1519 delete $env->{LC_ALL};
1520 $env->{LC_CTYPE} = $self->{term}->locale;
1521
1522 urxvt::term->new ($env, $self->{term}->resource ("name"),
1187 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1523 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1188 "--transient-for" => $self->{term}->parent, 1524 "--transient-for" => $self->{term}->parent,
1525 "-display" => $self->{term}->display_id,
1189 "-pe" => "urxvt-popup") 1526 "-pe" => "urxvt-popup")
1190 or die "unable to create popup window\n"; 1527 or die "unable to create popup window\n";
1191} 1528}
1192 1529
1193sub DESTROY { 1530sub DESTROY {
1194 my ($self) = @_; 1531 my ($self) = @_;
1195 1532
1196 delete $self->{term}{_destroy}{$self}; 1533 delete $self->{term}{_destroy}{$self};
1197 $self->{term}->ungrab; 1534 $self->{term}->ungrab;
1198} 1535}
1536
1537=back
1199 1538
1200=head2 The C<urxvt::timer> Class 1539=head2 The C<urxvt::timer> Class
1201 1540
1202This class implements timer watchers/events. Time is represented as a 1541This class implements timer watchers/events. Time is represented as a
1203fractional number of seconds since the epoch. Example: 1542fractional number of seconds since the epoch. Example:
1256 1595
1257 $term->{socket} = ... 1596 $term->{socket} = ...
1258 $term->{iow} = urxvt::iow 1597 $term->{iow} = urxvt::iow
1259 ->new 1598 ->new
1260 ->fd (fileno $term->{socket}) 1599 ->fd (fileno $term->{socket})
1261 ->events (1) # wait for read data 1600 ->events (urxvt::EVENT_READ)
1262 ->start 1601 ->start
1263 ->cb (sub { 1602 ->cb (sub {
1264 my ($iow, $revents) = @_; 1603 my ($iow, $revents) = @_;
1265 # $revents must be 1 here, no need to check 1604 # $revents must be 1 here, no need to check
1266 sysread $term->{socket}, my $buf, 8192 1605 sysread $term->{socket}, my $buf, 8192
1283 1622
1284Set the filedescriptor (not handle) to watch. 1623Set the filedescriptor (not handle) to watch.
1285 1624
1286=item $iow = $iow->events ($eventmask) 1625=item $iow = $iow->events ($eventmask)
1287 1626
1288Set the event mask to watch. Bit #0 (value C<1>) enables watching for read 1627Set the event mask to watch. The only allowed values are
1289data, Bit #1 (value C<2>) enables watching for write data. 1628C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
1629together, or C<urxvt::EVENT_NONE>.
1290 1630
1291=item $iow = $iow->start 1631=item $iow = $iow->start
1292 1632
1293Start watching for requested events on the given handle. 1633Start watching for requested events on the given handle.
1294 1634
1309 1649
1310=item == 0 - fatal messages 1650=item == 0 - fatal messages
1311 1651
1312=item >= 3 - script loading and management 1652=item >= 3 - script loading and management
1313 1653
1314=item >=10 - all events received 1654=item >=10 - all called hooks
1655
1656=item >=11 - hook reutrn values
1315 1657
1316=back 1658=back
1317 1659
1318=head1 AUTHOR 1660=head1 AUTHOR
1319 1661

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines