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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines