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.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
58 80
59=back 81=back
60 82
61=item option-popup (enabled by default) 83=item option-popup (enabled by default)
62 84
63Binds a popup menu to Ctrl-Button3 that lets you toggle (some) options at 85Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
64runtime. 86runtime.
65 87
66=item digital-clock 88=item selection-popup (enabled by default)
67 89
68Displays a digital clock using the built-in overlay. 90Binds a popup menu to Ctrl-Button3 that lets you convert the selection
91text into various other formats/action (such as uri unescaping, perl
92evalution, web-browser starting etc.), depending on content.
93
94=item searchable-scrollback<hotkey> (enabled by default)
95
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 :)
69 133
70=item mark-urls 134=item mark-urls
71 135
72Uses 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.
73 140
74=item block-graphics-to-ascii 141=item block-graphics-to-ascii
75 142
76A 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,
77by replacing all line-drawing characters (U+2500 .. U+259F) by a 144by replacing all line-drawing characters (U+2500 .. U+259F) by a
78similar-looking ascii character. 145similar-looking ascii character.
79 146
147=item digital-clock
148
149Displays a digital clock using the built-in overlay.
150
80=item example-refresh-hooks 151=item example-refresh-hooks
81 152
82Displays 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
83window. Illustrates overwriting the refresh callbacks to create your own 154window. Illustrates overwriting the refresh callbacks to create your own
84overlays or changes. 155overlays or changes.
85 156
86=back 157=back
158
159=head1 API DOCUMENTATION
87 160
88=head2 General API Considerations 161=head2 General API Considerations
89 162
90All objects (such as terminals, time watchers etc.) are typical 163All objects (such as terminals, time watchers etc.) are typical
91reference-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
104=over 4 177=over 4
105 178
106=item $text 179=item $text
107 180
108Rxvt-unicodes special way of encoding text, where one "unicode" character 181Rxvt-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. 182always represents one screen cell. See L<ROW_t> for a discussion of this format.
110 183
111=item $string 184=item $string
112 185
113A 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
114characters and is to be distinguished with text encoded in a specific 187characters and is to be distinguished with text encoded in a specific
119Either binary data or - more common - a text string encoded in a 192Either binary data or - more common - a text string encoded in a
120locale-specific way. 193locale-specific way.
121 194
122=back 195=back
123 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
124=head2 Hooks 230=head2 Hooks
125 231
126The following subroutines can be declared in extension files, and will be 232The following subroutines can be declared in extension files, and will be
127called whenever the relevant event happens. 233called whenever the relevant event happens.
128 234
129The 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
130and extension package. You can call all C<urxvt::term> methods on it, but 236the 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 237
136All 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
137counts 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
138and 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.
139 241
140When in doubt, return a false value (preferably C<()>). 242I<< When in doubt, return a false value (preferably C<()>). >>
141 243
142=over 4 244=over 4
143 245
144=item on_init $term 246=item on_init $term
145 247
180=item on_sel_extend $term 282=item on_sel_extend $term
181 283
182Called 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
183click) and is either supposed to return false (normal operation), or 285click) and is either supposed to return false (normal operation), or
184should 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
185processing. 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.
186 290
187See the F<selection> example extension. 291See the F<selection> example extension.
188 292
189=item on_view_change $term, $offset 293=item on_view_change $term, $offset
190 294
199than the scroll back buffer or the terminal. 303than the scroll back buffer or the terminal.
200 304
201It 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,
202$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
203number of lines that will be in the scrollback buffer. 307number 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 308
209=item on_osc_seq $term, $string 309=item on_osc_seq $term, $string
210 310
211Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 311Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
212operating system command) is processed. Cursor position and other state 312operating system command) is processed. Cursor position and other state
225can 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
226and calling C<< $term->scr_add_lines >> yourself. Please note that this 326and 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 327might be very slow, however, as your hook is called for B<all> text being
228output. 328output.
229 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
230=item on_line_update $term, $row 335=item on_line_update $term, $row
231 336
232Called 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
233screen output (e.g. underline urls or other useless stuff). Only lines 338screen output (e.g. underline urls or other useless stuff). Only lines
234that are being shown will be filtered, and, due to performance reasons, 339that are being shown will be filtered, and, due to performance reasons,
266=item on_focus_out $term 371=item on_focus_out $term
267 372
268Called wheneever the window loses keyboard focus, before rxvt-unicode does 373Called wheneever the window loses keyboard focus, before rxvt-unicode does
269focus out processing. 374focus out processing.
270 375
271=item on_key_press $term, $event, $octets 376=item on_key_press $term, $event, $keysym, $octets
272 377
273=item on_key_release $term, $event 378=item on_key_release $term, $event, $keysym
274 379
275=item on_button_press $term, $event 380=item on_button_press $term, $event
276 381
277=item on_button_release $term, $event 382=item on_button_release $term, $event
278 383
294 399
295subwindow. 400subwindow.
296 401
297=back 402=back
298 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
299=head2 Variables in the C<urxvt> Package 425=head2 Variables in the C<urxvt> Package
300 426
301=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>.
302 441
303=item $urxvt::TERM 442=item $urxvt::TERM
304 443
305The current terminal. This variable stores the current C<urxvt::term> 444The current terminal. This variable stores the current C<urxvt::term>
306object, whenever a callback/hook is executing. 445object, whenever a callback/hook is executing.
308=back 447=back
309 448
310=head2 Functions in the C<urxvt> Package 449=head2 Functions in the C<urxvt> Package
311 450
312=over 4 451=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 452
322=item urxvt::fatal $errormessage 453=item urxvt::fatal $errormessage
323 454
324Fatally aborts execution with the given error message. Avoid at all 455Fatally aborts execution with the given error message. Avoid at all
325costs! The only time this is acceptable is when the terminal process 456costs! The only time this is acceptable is when the terminal process
331newline. The module also overwrites the C<warn> builtin with a function 462newline. The module also overwrites the C<warn> builtin with a function
332that calls this function. 463that calls this function.
333 464
334Using 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
335correct 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.
336 475
337=item $time = urxvt::NOW 476=item $time = urxvt::NOW
338 477
339Returns the "current time" (as per the event loop). 478Returns the "current time" (as per the event loop).
340 479
379 518
380=item $background = urxvt::GET_BASEBG $rend 519=item $background = urxvt::GET_BASEBG $rend
381 520
382Return the foreground/background colour index, respectively. 521Return the foreground/background colour index, respectively.
383 522
384=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) 523=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
385 524
386=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) 525=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
387 526
388Replace the foreground/background colour in the rendition mask with the 527Replace the foreground/background colour in the rendition mask with the
389specified one. 528specified one.
390 529
391=item $value = urxvt::GET_CUSTOM ($rend) 530=item $value = urxvt::GET_CUSTOM $rend
392 531
393Return the "custom" value: Every rendition has 5 bits for use by 532Return the "custom" value: Every rendition has 5 bits for use by
394extensions. 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
395zero. 534zero.
396 535
397=item $rend = urxvt::SET_CUSTOM ($rend, $new_value) 536=item $rend = urxvt::SET_CUSTOM $rend, $new_value
398 537
399Change the custom value. 538Change the custom value.
400 539
401=back 540=back
402 541
403=cut 542=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 543
418BEGIN { 544BEGIN {
419 urxvt->bootstrap; 545 urxvt->bootstrap;
420 546
421 # overwrite perl's warn 547 # overwrite perl's warn
423 my $msg = join "", @_; 549 my $msg = join "", @_;
424 $msg .= "\n" 550 $msg .= "\n"
425 unless $msg =~ /\n$/; 551 unless $msg =~ /\n$/;
426 urxvt::warn ($msg); 552 urxvt::warn ($msg);
427 }; 553 };
554
555 # %ENV is the original startup environment
556 delete $ENV{IFS};
557 delete $ENV{CDPATH};
558 delete $ENV{BASH_ENV};
559 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
428} 560}
429 561
430my @hook_count; 562my @hook_count;
431my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 563my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
432 564
433sub verbose { 565sub verbose {
434 my ($level, $msg) = @_; 566 my ($level, $msg) = @_;
435 warn "$msg\n" if $level <= $verbosity; 567 warn "$msg\n" if $level <= $verbosity;
436} 568}
437 569
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"; 570my $extension_pkg = "extension0000";
456my %extension_pkg; 571my %extension_pkg;
457 572
458# load a single script into its own package, once only 573# load a single script into its own package, once only
459sub extension_package($) { 574sub extension_package($) {
465 verbose 3, "loading extension '$path' into package '$pkg'"; 580 verbose 3, "loading extension '$path' into package '$pkg'";
466 581
467 open my $fh, "<:raw", $path 582 open my $fh, "<:raw", $path
468 or die "$path: $!"; 583 or die "$path: $!";
469 584
585 my $source = untaint
470 my $source = "package $pkg; use strict; use utf8;\n" 586 "package $pkg; use strict; use utf8;\n"
471 . "use base urxvt::term::proxy::;\n" 587 . "use base urxvt::term::extension::;\n"
472 . "#line 1 \"$path\"\n{\n" 588 . "#line 1 \"$path\"\n{\n"
473 . (do { local $/; <$fh> }) 589 . (do { local $/; <$fh> })
474 . "\n};\n1"; 590 . "\n};\n1";
475 591
476 $source =~ /(.*)/s and $source = $1; # untaint 592 eval $source
477
478 eval $source or die "$path: $@"; 593 or die "$path: $@";
479 594
480 $pkg 595 $pkg
481 } 596 }
482} 597}
483 598
489 my $htype = shift; 604 my $htype = shift;
490 605
491 if ($htype == 0) { # INIT 606 if ($htype == 0) { # INIT
492 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 607 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
493 608
494 my %want_ext; 609 my %ext_arg;
495 610
496 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 611 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
497 if ($_ eq "default") { 612 if ($_ eq "default") {
498 $want_ext{$_}++ for qw(selection option-popup); 613 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
499 } elsif (/^-(.*)$/) { 614 } elsif (/^-(.*)$/) {
500 delete $want_ext{$1}; 615 delete $ext_arg{$1};
616 } elsif (/^([^<]+)<(.*)>$/) {
617 push @{ $ext_arg{$1} }, $2;
501 } else { 618 } else {
502 $want_ext{$_}++; 619 $ext_arg{$_} ||= [];
503 } 620 }
504 } 621 }
505 622
506 for my $ext (keys %want_ext) { 623 while (my ($ext, $argv) = each %ext_arg) {
507 my @files = grep -f $_, map "$_/$ext", @dirs; 624 my @files = grep -f $_, map "$_/$ext", @dirs;
508 625
509 if (@files) { 626 if (@files) {
510 register_package extension_package $files[0]; 627 $TERM->register_package (extension_package $files[0], $argv);
511 } else { 628 } else {
512 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";
513 } 630 }
514 } 631 }
515 632
524 if $verbosity >= 10; 641 if $verbosity >= 10;
525 642
526 keys %$cb; 643 keys %$cb;
527 644
528 while (my ($pkg, $cb) = each %$cb) { 645 while (my ($pkg, $cb) = each %$cb) {
529 eval { 646 $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; 647 and last;
538 }; 648
539 if ($@) { 649 if ($@) {
540 $TERM->ungrab; # better to lose the grab than the session 650 $TERM->ungrab; # better to lose the grab than the session
541 warn $@; 651 warn $@;
542 } 652 }
543 } 653 }
654
655 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
656 if $verbosity >= 11;
544 } 657 }
545 658
546 if ($htype == 1) { # DESTROY 659 if ($htype == 1) { # DESTROY
547 # remove hooks if unused
548 if (my $hook = $TERM->{_hook}) { 660 if (my $hook = delete $TERM->{_hook}) {
549 for my $htype (0..$#$hook) { 661 for my $htype (0..$#$hook) {
550 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } 662 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
551 or set_should_invoke $htype, 0; 663 or set_should_invoke $htype, 0;
552 } 664 }
553 } 665 }
560 } 672 }
561 673
562 $retval 674 $retval
563} 675}
564 676
565# urxvt::term::proxy 677sub exec_async(@) {
678 my $pid = fork;
566 679
567sub urxvt::term::proxy::AUTOLOAD { 680 return
568 $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 =~ /:([^:]+)$/
569 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 731 or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
570 732
571 eval qq{ 733 eval qq{
572 sub $urxvt::term::proxy::AUTOLOAD { 734 sub $AUTOLOAD {
573 my \$proxy = shift; 735 my \$proxy = shift;
574 \$proxy->{term}->$1 (\@_) 736 \$proxy->{term}->$1 (\@_)
575 } 737 }
576 1 738 1
577 } or die "FATAL: unable to compile method forwarder: $@"; 739 } or die "FATAL: unable to compile method forwarder: $@";
578 740
579 goto &$urxvt::term::proxy::AUTOLOAD; 741 goto &$AUTOLOAD;
580} 742}
581 743
582sub urxvt::term::proxy::DESTROY { 744sub DESTROY {
583 # nop 745 # nop
584} 746}
585 747
586# urxvt::destroy_hook 748# urxvt::destroy_hook
587 749
597 759
598=head2 The C<urxvt::anyevent> Class 760=head2 The C<urxvt::anyevent> Class
599 761
600The 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
601C<AnyEvent> module - any module using it will work inside urxvt without 763C<AnyEvent> module - any module using it will work inside urxvt without
602further work. The only exception is that you cannot wait on condition 764further programming. The only exception is that you cannot wait on
603variables, 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
604cannot use blocking APIs, but the non-blocking variant should work. 766is that you cannot use blocking APIs, but the non-blocking variant should
767work.
605 768
606=cut 769=cut
607 770
608our $VERSION = 1; 771our $VERSION = 1;
609 772
654 ${$_[0]}++; 817 ${$_[0]}++;
655} 818}
656 819
657sub urxvt::anyevent::condvar::wait { 820sub urxvt::anyevent::condvar::wait {
658 unless (${$_[0]}) { 821 unless (${$_[0]}) {
659 require Carp;
660 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";
661 } 823 }
662} 824}
663 825
664package urxvt::term; 826package urxvt::term;
665 827
666=head2 The C<urxvt::term> Class 828=head2 The C<urxvt::term> Class
667 829
668=over 4 830=over 4
669 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
670=item $term->destroy 873=item $term->destroy
671 874
672Destroy 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.
673 878
674=item $isset = $term->option ($optval[, $set]) 879=item $isset = $term->option ($optval[, $set])
675 880
676Returns true if the option specified by C<$optval> is enabled, and 881Returns true if the option specified by C<$optval> is enabled, and
677optionally 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
727 my ($self, $name) = (shift, shift); 932 my ($self, $name) = (shift, shift);
728 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 933 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
729 &urxvt::term::_resource 934 &urxvt::term::_resource
730} 935}
731 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
732=item $rend = $term->rstyle ([$new_rstyle]) 953=item $rend = $term->rstyle ([$new_rstyle])
733 954
734Return and optionally change the current rendition. Text that is output by 955Return and optionally change the current rendition. Text that is output by
735the terminal application will use this style. 956the terminal application will use this style.
736 957
746=item ($row, $col) = $term->selection_end ([$row, $col]) 967=item ($row, $col) = $term->selection_end ([$row, $col])
747 968
748Return the current values of the selection mark, begin or end positions, 969Return the current values of the selection mark, begin or end positions,
749and optionally set them to new values. 970and optionally set them to new values.
750 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
751=item $success = $term->selection_grab ($eventtime) 979=item $success = $term->selection_grab ($eventtime)
752 980
753Try 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
754by 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.
755 984
756=item $oldtext = $term->selection ([$newtext]) 985=item $oldtext = $term->selection ([$newtext])
757 986
758Return the current selection text and optionally replace it by C<$newtext>. 987Return the current selection text and optionally replace it by C<$newtext>.
759 988
760#=item $term->overlay ($x, $y, $text) 989=item $term->overlay_simple ($x, $y, $text)
761# 990
762#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.
763# 992
764#=cut 993=cut
765# 994
766#sub urxvt::term::scr_overlay { 995sub overlay_simple {
767# my ($self, $x, $y, $text) = @_; 996 my ($self, $x, $y, $text) = @_;
768# 997
769# my @lines = split /\n/, $text; 998 my @lines = split /\n/, $text;
770# 999
771# my $w = 0; 1000 my $w = List::Util::max map $self->strwidth ($_), @lines;
772# for (map $self->strwidth ($_), @lines) { 1001
773# $w = $_ if $w < $_;
774# }
775#
776# $self->scr_overlay_new ($x, $y, $w, scalar @lines); 1002 my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
777# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; 1003 $overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
778#} 1004
1005 $overlay
1006}
779 1007
780=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) 1008=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
781 1009
782Create a new (empty) overlay at the given position with the given 1010Create a new (empty) overlay at the given position with the given
783width/height. C<$rstyle> defines the initial rendition style 1011width/height. C<$rstyle> defines the initial rendition style
850 1078
851=item $string = $term->locale_decode ($octets) 1079=item $string = $term->locale_decode ($octets)
852 1080
853Convert the given locale-encoded octets into a perl string. 1081Convert the given locale-encoded octets into a perl string.
854 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
855=item $term->scr_add_lines ($string) 1100=item $term->scr_add_lines ($string)
856 1101
857Write 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
858running inside the terminal. It may not contain command sequences (escape 1103running inside the terminal. It may not contain command sequences (escape
859codes), 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
873 1118
874Write 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
875pass characters instead of octets, you should convert your strings first 1120pass characters instead of octets, you should convert your strings first
876to the locale-specific encoding using C<< $term->locale_encode >>. 1121to the locale-specific encoding using C<< $term->locale_encode >>.
877 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
878=item $windowid = $term->parent 1130=item $windowid = $term->parent
879 1131
880Return the window id of the toplevel window. 1132Return the window id of the toplevel window.
881 1133
882=item $windowid = $term->vt 1134=item $windowid = $term->vt
906=item $nrow_plus_saveLines = $term->total_rows 1158=item $nrow_plus_saveLines = $term->total_rows
907 1159
908=item $lines_in_scrollback = $term->nsaved 1160=item $lines_in_scrollback = $term->nsaved
909 1161
910Return 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}
911 1186
912=item $modifiermask = $term->ModLevel3Mask 1187=item $modifiermask = $term->ModLevel3Mask
913 1188
914=item $modifiermask = $term->ModMetaMask 1189=item $modifiermask = $term->ModMetaMask
915 1190
1008Return 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.
1009 1284
1010=item $offset = $line->offset_of ($row, $col) 1285=item $offset = $line->offset_of ($row, $col)
1011 1286
1012Returns 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
1013line. 1288line. Works for rows outside the line, too, and returns corresponding
1289offsets outside the string.
1014 1290
1015=item ($row, $col) = $line->coord_of ($offset) 1291=item ($row, $col) = $line->coord_of ($offset)
1016 1292
1017Translates a string offset into terminal coordinates again. 1293Translates a string offset into terminal coordinates again.
1018 1294
1092 $offset / $self->{ncol} + $self->{beg}, 1368 $offset / $self->{ncol} + $self->{beg},
1093 $offset % $self->{ncol} 1369 $offset % $self->{ncol}
1094 ) 1370 )
1095} 1371}
1096 1372
1097=item ($row, $col) = $line->coord_of ($offset)
1098=item $text = $term->special_encode $string 1373=item $text = $term->special_encode $string
1099 1374
1100Converts a perl string into the special encoding used by rxvt-unicode, 1375Converts a perl string into the special encoding used by rxvt-unicode,
1101where one character corresponds to one screen cell. See 1376where one character corresponds to one screen cell. See
1102C<< $term->ROW_t >> for details. 1377C<< $term->ROW_t >> for details.
1104=item $string = $term->special_decode $text 1379=item $string = $term->special_decode $text
1105 1380
1106Converts rxvt-unicodes text reprsentation into a perl string. See 1381Converts rxvt-unicodes text reprsentation into a perl string. See
1107C<< $term->ROW_t >> for details. 1382C<< $term->ROW_t >> for details.
1108 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
1109=back 1412=back
1110 1413
1111=cut 1414=cut
1112 1415
1113package urxvt::popup; 1416package urxvt::popup;
1128 $item->{render} ||= sub { $_[0]{text} }; 1431 $item->{render} ||= sub { $_[0]{text} };
1129 1432
1130 push @{ $self->{item} }, $item; 1433 push @{ $self->{item} }, $item;
1131} 1434}
1132 1435
1133sub add_separator { 1436=item $popup->add_title ($title)
1134 my ($self, $sep) = @_;
1135 1437
1136 $sep ||= "═"; 1438Adds a non-clickable title to the popup.
1137 1439
1138 $self->add_item ({ 1440=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 1441
1146sub add_title { 1442sub add_title {
1147 my ($self, $title) = @_; 1443 my ($self, $title) = @_;
1148 1444
1149 $self->add_item ({ 1445 $self->add_item ({
1151 text => $title, 1447 text => $title,
1152 activate => sub { }, 1448 activate => sub { },
1153 }); 1449 });
1154} 1450}
1155 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
1156sub add_button { 1478sub add_button {
1157 my ($self, $text, $cb) = @_; 1479 my ($self, $text, $cb) = @_;
1158 1480
1159 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb}); 1481 $self->add_item ({ type => "button", text => $text, activate => $cb});
1160} 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
1161 1491
1162sub add_toggle { 1492sub add_toggle {
1163 my ($self, $text, $cb, $value) = @_; 1493 my ($self, $text, $cb, $value) = @_;
1164 1494
1165 my $item; $item = { 1495 my $item; $item = {
1166 type => "button", 1496 type => "button",
1167 text => " $text", 1497 text => " $text",
1168 value => $value, 1498 value => $value,
1169 render => sub { ($_[0]{value} ? "* " : " ") . $text }, 1499 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1170 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); }, 1500 activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1171 }; 1501 };
1172 1502
1173 $self->add_item ($item); 1503 $self->add_item ($item);
1174} 1504}
1505
1506=item $popup->show
1507
1508Displays the popup (which is initially hidden).
1509
1510=cut
1175 1511
1176sub show { 1512sub show {
1177 my ($self) = @_; 1513 my ($self) = @_;
1178 1514
1179 local $urxvt::popup::self = $self; 1515 local $urxvt::popup::self = $self;
1180 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"),
1181 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,
1182 "--transient-for" => $self->{term}->parent, 1524 "--transient-for" => $self->{term}->parent,
1525 "-display" => $self->{term}->display_id,
1183 "-pe" => "urxvt-popup") 1526 "-pe" => "urxvt-popup")
1184 or die "unable to create popup window\n"; 1527 or die "unable to create popup window\n";
1185} 1528}
1186 1529
1187sub DESTROY { 1530sub DESTROY {
1188 my ($self) = @_; 1531 my ($self) = @_;
1189 1532
1190 delete $self->{term}{_destroy}{$self}; 1533 delete $self->{term}{_destroy}{$self};
1191 $self->{term}->ungrab; 1534 $self->{term}->ungrab;
1192} 1535}
1536
1537=back
1193 1538
1194=head2 The C<urxvt::timer> Class 1539=head2 The C<urxvt::timer> Class
1195 1540
1196This class implements timer watchers/events. Time is represented as a 1541This class implements timer watchers/events. Time is represented as a
1197fractional number of seconds since the epoch. Example: 1542fractional number of seconds since the epoch. Example:
1250 1595
1251 $term->{socket} = ... 1596 $term->{socket} = ...
1252 $term->{iow} = urxvt::iow 1597 $term->{iow} = urxvt::iow
1253 ->new 1598 ->new
1254 ->fd (fileno $term->{socket}) 1599 ->fd (fileno $term->{socket})
1255 ->events (1) # wait for read data 1600 ->events (urxvt::EVENT_READ)
1256 ->start 1601 ->start
1257 ->cb (sub { 1602 ->cb (sub {
1258 my ($iow, $revents) = @_; 1603 my ($iow, $revents) = @_;
1259 # $revents must be 1 here, no need to check 1604 # $revents must be 1 here, no need to check
1260 sysread $term->{socket}, my $buf, 8192 1605 sysread $term->{socket}, my $buf, 8192
1277 1622
1278Set the filedescriptor (not handle) to watch. 1623Set the filedescriptor (not handle) to watch.
1279 1624
1280=item $iow = $iow->events ($eventmask) 1625=item $iow = $iow->events ($eventmask)
1281 1626
1282Set 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
1283data, 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>.
1284 1630
1285=item $iow = $iow->start 1631=item $iow = $iow->start
1286 1632
1287Start watching for requested events on the given handle. 1633Start watching for requested events on the given handle.
1288 1634
1303 1649
1304=item == 0 - fatal messages 1650=item == 0 - fatal messages
1305 1651
1306=item >= 3 - script loading and management 1652=item >= 3 - script loading and management
1307 1653
1308=item >=10 - all events received 1654=item >=10 - all called hooks
1655
1656=item >=11 - hook reutrn values
1309 1657
1310=back 1658=back
1311 1659
1312=head1 AUTHOR 1660=head1 AUTHOR
1313 1661

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines