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.60 by root, Mon Jan 9 01:21:43 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
64runtime. 86runtime.
65 87
66=item selection-popup (enabled by default) 88=item selection-popup (enabled by default)
67 89
68Binds a popup menu to Ctrl-Button3 that lets you convert the selection 90Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69text into various other formats/action. 91text into various other formats/action (such as uri unescaping, perl
92evalution, web-browser starting etc.), depending on content.
70 93
71=item digital-clock 94=item searchable-scrollback<hotkey> (enabled by default)
72 95
73Displays a digital clock using the built-in overlay. 96Adds regex search functionality to the scrollback buffer, triggered
97by a hotkey (default: C<M-s>). While in search mode, normal terminal
98input/output is suspended and a regex is displayed at the bottom of the
99screen.
100
101Inputting characters appends them to the regex and continues incremental
102search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
103search upwards/downwards in the scrollback buffer, C<End> jumps to the
104bottom. C<Escape> leaves search mode and returns to the point where search
105was started, while C<Enter> or C<Return> stay at the current position and
106additionally stores the first match in the current line into the primary
107selection.
108
109=item selection-autotransform
110
111This selection allows you to do automatic transforms on a selection
112whenever a selection is made.
113
114It works by specifying perl snippets (most useful is a single C<s///>
115operator) that modify C<$_> as resources:
116
117 URxvt.selection-autotransform.0: transform
118 URxvt.selection-autotransform.1: transform
119 ...
120
121For example, the following will transform selections of the form
122C<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/
74 130
75=item mark-urls 131=item mark-urls
76 132
77Uses 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.
78 137
79=item block-graphics-to-ascii 138=item block-graphics-to-ascii
80 139
81A 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,
82by replacing all line-drawing characters (U+2500 .. U+259F) by a 141by replacing all line-drawing characters (U+2500 .. U+259F) by a
83similar-looking ascii character. 142similar-looking ascii character.
84 143
144=item digital-clock
145
146Displays a digital clock using the built-in overlay.
147
85=item example-refresh-hooks 148=item example-refresh-hooks
86 149
87Displays 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
88window. Illustrates overwriting the refresh callbacks to create your own 151window. Illustrates overwriting the refresh callbacks to create your own
89overlays or changes. 152overlays or changes.
90 153
91=back 154=back
155
156=head1 API DOCUMENTATION
92 157
93=head2 General API Considerations 158=head2 General API Considerations
94 159
95All objects (such as terminals, time watchers etc.) are typical 160All objects (such as terminals, time watchers etc.) are typical
96reference-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
109=over 4 174=over 4
110 175
111=item $text 176=item $text
112 177
113Rxvt-unicodes special way of encoding text, where one "unicode" character 178Rxvt-unicodes special way of encoding text, where one "unicode" character
114always represents one screen cell. See L<row_t> for a discussion of this format. 179always represents one screen cell. See L<ROW_t> for a discussion of this format.
115 180
116=item $string 181=item $string
117 182
118A 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
119characters and is to be distinguished with text encoded in a specific 184characters and is to be distinguished with text encoded in a specific
124Either binary data or - more common - a text string encoded in a 189Either binary data or - more common - a text string encoded in a
125locale-specific way. 190locale-specific way.
126 191
127=back 192=back
128 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
129=head2 Hooks 227=head2 Hooks
130 228
131The following subroutines can be declared in extension files, and will be 229The following subroutines can be declared in extension files, and will be
132called whenever the relevant event happens. 230called whenever the relevant event happens.
133 231
134The 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
135and extension package. You can call all C<urxvt::term> methods on it, but 233the in the C<Extension Objects> section.
136its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
137object that is shared between all packages is stored in the C<term>
138member. It is, however, blessed intot he package of the extension script,
139so for all practical purposes you can treat an extension script as a class.
140 234
141All 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
142counts 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
143and 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.
144 238
145When in doubt, return a false value (preferably C<()>). 239I<< When in doubt, return a false value (preferably C<()>). >>
146 240
147=over 4 241=over 4
148 242
149=item on_init $term 243=item on_init $term
150 244
185=item on_sel_extend $term 279=item on_sel_extend $term
186 280
187Called 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
188click) and is either supposed to return false (normal operation), or 282click) and is either supposed to return false (normal operation), or
189should 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
190processing. 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.
191 287
192See the F<selection> example extension. 288See the F<selection> example extension.
193 289
194=item on_view_change $term, $offset 290=item on_view_change $term, $offset
195 291
204than the scroll back buffer or the terminal. 300than the scroll back buffer or the terminal.
205 301
206It 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,
207$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
208number of lines that will be in the scrollback buffer. 304number of lines that will be in the scrollback buffer.
209
210=item on_tty_activity $term *NYI*
211
212Called whenever the program(s) running in the urxvt window send output.
213 305
214=item on_osc_seq $term, $string 306=item on_osc_seq $term, $string
215 307
216Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 308Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
217operating system command) is processed. Cursor position and other state 309operating system command) is processed. Cursor position and other state
230can 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
231and calling C<< $term->scr_add_lines >> yourself. Please note that this 323and calling C<< $term->scr_add_lines >> yourself. Please note that this
232might be very slow, however, as your hook is called for B<all> text being 324might be very slow, however, as your hook is called for B<all> text being
233output. 325output.
234 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
235=item on_line_update $term, $row 332=item on_line_update $term, $row
236 333
237Called 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
238screen output (e.g. underline urls or other useless stuff). Only lines 335screen output (e.g. underline urls or other useless stuff). Only lines
239that are being shown will be filtered, and, due to performance reasons, 336that are being shown will be filtered, and, due to performance reasons,
271=item on_focus_out $term 368=item on_focus_out $term
272 369
273Called wheneever the window loses keyboard focus, before rxvt-unicode does 370Called wheneever the window loses keyboard focus, before rxvt-unicode does
274focus out processing. 371focus out processing.
275 372
276=item on_key_press $term, $event, $octets 373=item on_key_press $term, $event, $keysym, $octets
277 374
278=item on_key_release $term, $event 375=item on_key_release $term, $event, $keysym
279 376
280=item on_button_press $term, $event 377=item on_button_press $term, $event
281 378
282=item on_button_release $term, $event 379=item on_button_release $term, $event
283 380
299 396
300subwindow. 397subwindow.
301 398
302=back 399=back
303 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
304=head2 Variables in the C<urxvt> Package 422=head2 Variables in the C<urxvt> Package
305 423
306=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>.
307 438
308=item $urxvt::TERM 439=item $urxvt::TERM
309 440
310The current terminal. This variable stores the current C<urxvt::term> 441The current terminal. This variable stores the current C<urxvt::term>
311object, whenever a callback/hook is executing. 442object, whenever a callback/hook is executing.
313=back 444=back
314 445
315=head2 Functions in the C<urxvt> Package 446=head2 Functions in the C<urxvt> Package
316 447
317=over 4 448=over 4
318
319=item $term = new urxvt [arg...]
320
321Creates a new terminal, very similar as if you had started it with
322C<system $binfile, arg...>. Croaks (and probably outputs an error message)
323if the new instance couldn't be created. Returns C<undef> if the new
324instance didn't initialise perl, and the terminal object otherwise. The
325C<init> and C<start> hooks will be called during the call.
326 449
327=item urxvt::fatal $errormessage 450=item urxvt::fatal $errormessage
328 451
329Fatally aborts execution with the given error message. Avoid at all 452Fatally aborts execution with the given error message. Avoid at all
330costs! The only time this is acceptable is when the terminal process 453costs! The only time this is acceptable is when the terminal process
336newline. The module also overwrites the C<warn> builtin with a function 459newline. The module also overwrites the C<warn> builtin with a function
337that calls this function. 460that calls this function.
338 461
339Using 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
340correct 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.
341 472
342=item $time = urxvt::NOW 473=item $time = urxvt::NOW
343 474
344Returns the "current time" (as per the event loop). 475Returns the "current time" (as per the event loop).
345 476
384 515
385=item $background = urxvt::GET_BASEBG $rend 516=item $background = urxvt::GET_BASEBG $rend
386 517
387Return the foreground/background colour index, respectively. 518Return the foreground/background colour index, respectively.
388 519
389=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) 520=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
390 521
391=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) 522=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
392 523
393Replace the foreground/background colour in the rendition mask with the 524Replace the foreground/background colour in the rendition mask with the
394specified one. 525specified one.
395 526
396=item $value = urxvt::GET_CUSTOM ($rend) 527=item $value = urxvt::GET_CUSTOM $rend
397 528
398Return the "custom" value: Every rendition has 5 bits for use by 529Return the "custom" value: Every rendition has 5 bits for use by
399extensions. 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
400zero. 531zero.
401 532
402=item $rend = urxvt::SET_CUSTOM ($rend, $new_value) 533=item $rend = urxvt::SET_CUSTOM $rend, $new_value
403 534
404Change the custom value. 535Change the custom value.
405 536
406=back 537=back
407 538
408=cut 539=cut
409
410package urxvt;
411
412use utf8;
413use strict;
414use Scalar::Util ();
415use List::Util ();
416
417our $VERSION = 1;
418our $TERM;
419our @HOOKNAME;
420our %OPTION;
421our $LIBDIR;
422 540
423BEGIN { 541BEGIN {
424 urxvt->bootstrap; 542 urxvt->bootstrap;
425 543
426 # overwrite perl's warn 544 # overwrite perl's warn
429 $msg .= "\n" 547 $msg .= "\n"
430 unless $msg =~ /\n$/; 548 unless $msg =~ /\n$/;
431 urxvt::warn ($msg); 549 urxvt::warn ($msg);
432 }; 550 };
433 551
552 # %ENV is the original startup environment
434 delete $ENV{IFS}; 553 delete $ENV{IFS};
435 delete $ENV{CDPATH}; 554 delete $ENV{CDPATH};
436 delete $ENV{BASH_ENV}; 555 delete $ENV{BASH_ENV};
437 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; 556 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
438} 557}
443sub verbose { 562sub verbose {
444 my ($level, $msg) = @_; 563 my ($level, $msg) = @_;
445 warn "$msg\n" if $level <= $verbosity; 564 warn "$msg\n" if $level <= $verbosity;
446} 565}
447 566
448# find on_xxx subs in the package and register them
449# as hooks
450sub register_package($) {
451 my ($pkg) = @_;
452
453 for my $htype (0.. $#HOOKNAME) {
454 my $name = $HOOKNAME[$htype];
455
456 my $ref = $pkg->can ("on_" . lc $name)
457 or next;
458
459 $TERM->{_hook}[$htype]{$pkg} = $ref;
460 $hook_count[$htype]++
461 or set_should_invoke $htype, 1;
462 }
463}
464
465my $extension_pkg = "extension0000"; 567my $extension_pkg = "extension0000";
466my %extension_pkg; 568my %extension_pkg;
467 569
468# load a single script into its own package, once only 570# load a single script into its own package, once only
469sub extension_package($) { 571sub extension_package($) {
475 verbose 3, "loading extension '$path' into package '$pkg'"; 577 verbose 3, "loading extension '$path' into package '$pkg'";
476 578
477 open my $fh, "<:raw", $path 579 open my $fh, "<:raw", $path
478 or die "$path: $!"; 580 or die "$path: $!";
479 581
582 my $source = untaint
480 my $source = untaint "package $pkg; use strict; use utf8;\n" 583 "package $pkg; use strict; use utf8;\n"
481 . "use base urxvt::term::proxy::;\n" 584 . "use base urxvt::term::extension::;\n"
482 . "#line 1 \"$path\"\n{\n" 585 . "#line 1 \"$path\"\n{\n"
483 . (do { local $/; <$fh> }) 586 . (do { local $/; <$fh> })
484 . "\n};\n1"; 587 . "\n};\n1";
485 588
589 eval $source
486 eval $source or die "$path: $@"; 590 or die "$path: $@";
487 591
488 $pkg 592 $pkg
489 } 593 }
490} 594}
491 595
497 my $htype = shift; 601 my $htype = shift;
498 602
499 if ($htype == 0) { # INIT 603 if ($htype == 0) { # INIT
500 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 604 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
501 605
502 my %want_ext; 606 my %ext_arg;
503 607
504 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 608 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
505 if ($_ eq "default") { 609 if ($_ eq "default") {
506 $want_ext{$_}++ for qw(selection option-popup selection-popup); 610 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
507 } elsif (/^-(.*)$/) { 611 } elsif (/^-(.*)$/) {
508 delete $want_ext{$1}; 612 delete $ext_arg{$1};
613 } elsif (/^([^<]+)<(.*)>$/) {
614 push @{ $ext_arg{$1} }, $2;
509 } else { 615 } else {
510 $want_ext{$_}++; 616 $ext_arg{$_} ||= [];
511 } 617 }
512 } 618 }
513 619
514 for my $ext (keys %want_ext) { 620 while (my ($ext, $argv) = each %ext_arg) {
515 my @files = grep -f $_, map "$_/$ext", @dirs; 621 my @files = grep -f $_, map "$_/$ext", @dirs;
516 622
517 if (@files) { 623 if (@files) {
518 register_package extension_package $files[0]; 624 $TERM->register_package (extension_package $files[0], $argv);
519 } else { 625 } else {
520 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";
521 } 627 }
522 } 628 }
523 629
532 if $verbosity >= 10; 638 if $verbosity >= 10;
533 639
534 keys %$cb; 640 keys %$cb;
535 641
536 while (my ($pkg, $cb) = each %$cb) { 642 while (my ($pkg, $cb) = each %$cb) {
537 eval { 643 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
538 $retval = $cb->(
539 $TERM->{_pkg}{$pkg} ||= do {
540 my $proxy = bless { }, $pkg;
541 Scalar::Util::weaken ($proxy->{term} = $TERM);
542 $proxy
543 },
544 @_,
545 ) and last; 644 and last;
546 }; 645
547 if ($@) { 646 if ($@) {
548 $TERM->ungrab; # better to lose the grab than the session 647 $TERM->ungrab; # better to lose the grab than the session
549 warn $@; 648 warn $@;
550 } 649 }
551 } 650 }
651
652 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
653 if $verbosity >= 11;
552 } 654 }
553 655
554 if ($htype == 1) { # DESTROY 656 if ($htype == 1) { # DESTROY
555 # remove hooks if unused
556 if (my $hook = $TERM->{_hook}) { 657 if (my $hook = delete $TERM->{_hook}) {
557 for my $htype (0..$#$hook) { 658 for my $htype (0..$#$hook) {
558 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } 659 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
559 or set_should_invoke $htype, 0; 660 or set_should_invoke $htype, 0;
560 } 661 }
561 } 662 }
568 } 669 }
569 670
570 $retval 671 $retval
571} 672}
572 673
573# urxvt::term::proxy 674sub exec_async(@) {
675 my $pid = fork;
574 676
575sub urxvt::term::proxy::AUTOLOAD { 677 return
576 $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 =~ /:([^:]+)$/
577 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 728 or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
578 729
579 eval qq{ 730 eval qq{
580 sub $urxvt::term::proxy::AUTOLOAD { 731 sub $AUTOLOAD {
581 my \$proxy = shift; 732 my \$proxy = shift;
582 \$proxy->{term}->$1 (\@_) 733 \$proxy->{term}->$1 (\@_)
583 } 734 }
584 1 735 1
585 } or die "FATAL: unable to compile method forwarder: $@"; 736 } or die "FATAL: unable to compile method forwarder: $@";
586 737
587 goto &$urxvt::term::proxy::AUTOLOAD; 738 goto &$AUTOLOAD;
588} 739}
589 740
590sub urxvt::term::proxy::DESTROY { 741sub DESTROY {
591 # nop 742 # nop
592} 743}
593 744
594# urxvt::destroy_hook 745# urxvt::destroy_hook
595 746
605 756
606=head2 The C<urxvt::anyevent> Class 757=head2 The C<urxvt::anyevent> Class
607 758
608The 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
609C<AnyEvent> module - any module using it will work inside urxvt without 760C<AnyEvent> module - any module using it will work inside urxvt without
610further work. The only exception is that you cannot wait on condition 761further programming. The only exception is that you cannot wait on
611variables, 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
612cannot use blocking APIs, but the non-blocking variant should work. 763is that you cannot use blocking APIs, but the non-blocking variant should
764work.
613 765
614=cut 766=cut
615 767
616our $VERSION = 1; 768our $VERSION = 1;
617 769
662 ${$_[0]}++; 814 ${$_[0]}++;
663} 815}
664 816
665sub urxvt::anyevent::condvar::wait { 817sub urxvt::anyevent::condvar::wait {
666 unless (${$_[0]}) { 818 unless (${$_[0]}) {
667 require Carp;
668 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";
669 } 820 }
670} 821}
671 822
672package urxvt::term; 823package urxvt::term;
673 824
674=head2 The C<urxvt::term> Class 825=head2 The C<urxvt::term> Class
675 826
676=over 4 827=over 4
677 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
678=item $term->destroy 870=item $term->destroy
679 871
680Destroy 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.
681 875
682=item $isset = $term->option ($optval[, $set]) 876=item $isset = $term->option ($optval[, $set])
683 877
684Returns true if the option specified by C<$optval> is enabled, and 878Returns true if the option specified by C<$optval> is enabled, and
685optionally 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
735 my ($self, $name) = (shift, shift); 929 my ($self, $name) = (shift, shift);
736 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 930 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
737 &urxvt::term::_resource 931 &urxvt::term::_resource
738} 932}
739 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
740=item $rend = $term->rstyle ([$new_rstyle]) 950=item $rend = $term->rstyle ([$new_rstyle])
741 951
742Return and optionally change the current rendition. Text that is output by 952Return and optionally change the current rendition. Text that is output by
743the terminal application will use this style. 953the terminal application will use this style.
744 954
754=item ($row, $col) = $term->selection_end ([$row, $col]) 964=item ($row, $col) = $term->selection_end ([$row, $col])
755 965
756Return the current values of the selection mark, begin or end positions, 966Return the current values of the selection mark, begin or end positions,
757and optionally set them to new values. 967and optionally set them to new values.
758 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
759=item $success = $term->selection_grab ($eventtime) 976=item $success = $term->selection_grab ($eventtime)
760 977
761Try 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
762by 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.
763 981
764=item $oldtext = $term->selection ([$newtext]) 982=item $oldtext = $term->selection ([$newtext])
765 983
766Return the current selection text and optionally replace it by C<$newtext>. 984Return the current selection text and optionally replace it by C<$newtext>.
767 985
768#=item $term->overlay ($x, $y, $text) 986=item $term->overlay_simple ($x, $y, $text)
769# 987
770#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.
771# 989
772#=cut 990=cut
773# 991
774#sub urxvt::term::scr_overlay { 992sub overlay_simple {
775# my ($self, $x, $y, $text) = @_; 993 my ($self, $x, $y, $text) = @_;
776# 994
777# my @lines = split /\n/, $text; 995 my @lines = split /\n/, $text;
778# 996
779# my $w = 0; 997 my $w = List::Util::max map $self->strwidth ($_), @lines;
780# for (map $self->strwidth ($_), @lines) { 998
781# $w = $_ if $w < $_;
782# }
783#
784# $self->scr_overlay_new ($x, $y, $w, scalar @lines); 999 my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
785# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; 1000 $overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
786#} 1001
1002 $overlay
1003}
787 1004
788=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) 1005=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
789 1006
790Create a new (empty) overlay at the given position with the given 1007Create a new (empty) overlay at the given position with the given
791width/height. C<$rstyle> defines the initial rendition style 1008width/height. C<$rstyle> defines the initial rendition style
858 1075
859=item $string = $term->locale_decode ($octets) 1076=item $string = $term->locale_decode ($octets)
860 1077
861Convert the given locale-encoded octets into a perl string. 1078Convert the given locale-encoded octets into a perl string.
862 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
863=item $term->scr_add_lines ($string) 1097=item $term->scr_add_lines ($string)
864 1098
865Write 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
866running inside the terminal. It may not contain command sequences (escape 1100running inside the terminal. It may not contain command sequences (escape
867codes), 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
881 1115
882Write 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
883pass characters instead of octets, you should convert your strings first 1117pass characters instead of octets, you should convert your strings first
884to the locale-specific encoding using C<< $term->locale_encode >>. 1118to the locale-specific encoding using C<< $term->locale_encode >>.
885 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
886=item $windowid = $term->parent 1127=item $windowid = $term->parent
887 1128
888Return the window id of the toplevel window. 1129Return the window id of the toplevel window.
889 1130
890=item $windowid = $term->vt 1131=item $windowid = $term->vt
914=item $nrow_plus_saveLines = $term->total_rows 1155=item $nrow_plus_saveLines = $term->total_rows
915 1156
916=item $lines_in_scrollback = $term->nsaved 1157=item $lines_in_scrollback = $term->nsaved
917 1158
918Return 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}
919 1183
920=item $modifiermask = $term->ModLevel3Mask 1184=item $modifiermask = $term->ModLevel3Mask
921 1185
922=item $modifiermask = $term->ModMetaMask 1186=item $modifiermask = $term->ModMetaMask
923 1187
1016Return 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.
1017 1281
1018=item $offset = $line->offset_of ($row, $col) 1282=item $offset = $line->offset_of ($row, $col)
1019 1283
1020Returns 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
1021line. 1285line. Works for rows outside the line, too, and returns corresponding
1286offsets outside the string.
1022 1287
1023=item ($row, $col) = $line->coord_of ($offset) 1288=item ($row, $col) = $line->coord_of ($offset)
1024 1289
1025Translates a string offset into terminal coordinates again. 1290Translates a string offset into terminal coordinates again.
1026 1291
1100 $offset / $self->{ncol} + $self->{beg}, 1365 $offset / $self->{ncol} + $self->{beg},
1101 $offset % $self->{ncol} 1366 $offset % $self->{ncol}
1102 ) 1367 )
1103} 1368}
1104 1369
1105=item ($row, $col) = $line->coord_of ($offset)
1106=item $text = $term->special_encode $string 1370=item $text = $term->special_encode $string
1107 1371
1108Converts a perl string into the special encoding used by rxvt-unicode, 1372Converts a perl string into the special encoding used by rxvt-unicode,
1109where one character corresponds to one screen cell. See 1373where one character corresponds to one screen cell. See
1110C<< $term->ROW_t >> for details. 1374C<< $term->ROW_t >> for details.
1112=item $string = $term->special_decode $text 1376=item $string = $term->special_decode $text
1113 1377
1114Converts rxvt-unicodes text reprsentation into a perl string. See 1378Converts rxvt-unicodes text reprsentation into a perl string. See
1115C<< $term->ROW_t >> for details. 1379C<< $term->ROW_t >> for details.
1116 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
1117=back 1409=back
1118 1410
1119=cut 1411=cut
1120 1412
1121package urxvt::popup; 1413package urxvt::popup;
1136 $item->{render} ||= sub { $_[0]{text} }; 1428 $item->{render} ||= sub { $_[0]{text} };
1137 1429
1138 push @{ $self->{item} }, $item; 1430 push @{ $self->{item} }, $item;
1139} 1431}
1140 1432
1141sub add_separator { 1433=item $popup->add_title ($title)
1142 my ($self, $sep) = @_;
1143 1434
1144 $sep ||= "═"; 1435Adds a non-clickable title to the popup.
1145 1436
1146 $self->add_item ({ 1437=cut
1147 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1148 text => "",
1149 render => sub { $sep x $urxvt::TERM->ncol },
1150 activate => sub { },
1151 });
1152}
1153 1438
1154sub add_title { 1439sub add_title {
1155 my ($self, $title) = @_; 1440 my ($self, $title) = @_;
1156 1441
1157 $self->add_item ({ 1442 $self->add_item ({
1159 text => $title, 1444 text => $title,
1160 activate => sub { }, 1445 activate => sub { },
1161 }); 1446 });
1162} 1447}
1163 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
1164sub add_button { 1475sub add_button {
1165 my ($self, $text, $cb) = @_; 1476 my ($self, $text, $cb) = @_;
1166 1477
1167 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb}); 1478 $self->add_item ({ type => "button", text => $text, activate => $cb});
1168} 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
1169 1488
1170sub add_toggle { 1489sub add_toggle {
1171 my ($self, $text, $cb, $value) = @_; 1490 my ($self, $text, $cb, $value) = @_;
1172 1491
1173 my $item; $item = { 1492 my $item; $item = {
1174 type => "button", 1493 type => "button",
1175 text => " $text", 1494 text => " $text",
1176 value => $value, 1495 value => $value,
1177 render => sub { ($_[0]{value} ? "* " : " ") . $text }, 1496 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1178 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); }, 1497 activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1179 }; 1498 };
1180 1499
1181 $self->add_item ($item); 1500 $self->add_item ($item);
1182} 1501}
1502
1503=item $popup->show
1504
1505Displays the popup (which is initially hidden).
1506
1507=cut
1183 1508
1184sub show { 1509sub show {
1185 my ($self) = @_; 1510 my ($self) = @_;
1186 1511
1187 local $urxvt::popup::self = $self; 1512 local $urxvt::popup::self = $self;
1188 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"),
1189 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,
1190 "--transient-for" => $self->{term}->parent, 1521 "--transient-for" => $self->{term}->parent,
1522 "-display" => $self->{term}->display_id,
1191 "-pe" => "urxvt-popup") 1523 "-pe" => "urxvt-popup")
1192 or die "unable to create popup window\n"; 1524 or die "unable to create popup window\n";
1193} 1525}
1194 1526
1195sub DESTROY { 1527sub DESTROY {
1196 my ($self) = @_; 1528 my ($self) = @_;
1197 1529
1198 delete $self->{term}{_destroy}{$self}; 1530 delete $self->{term}{_destroy}{$self};
1199 $self->{term}->ungrab; 1531 $self->{term}->ungrab;
1200} 1532}
1533
1534=back
1201 1535
1202=head2 The C<urxvt::timer> Class 1536=head2 The C<urxvt::timer> Class
1203 1537
1204This class implements timer watchers/events. Time is represented as a 1538This class implements timer watchers/events. Time is represented as a
1205fractional number of seconds since the epoch. Example: 1539fractional number of seconds since the epoch. Example:
1258 1592
1259 $term->{socket} = ... 1593 $term->{socket} = ...
1260 $term->{iow} = urxvt::iow 1594 $term->{iow} = urxvt::iow
1261 ->new 1595 ->new
1262 ->fd (fileno $term->{socket}) 1596 ->fd (fileno $term->{socket})
1263 ->events (1) # wait for read data 1597 ->events (urxvt::EVENT_READ)
1264 ->start 1598 ->start
1265 ->cb (sub { 1599 ->cb (sub {
1266 my ($iow, $revents) = @_; 1600 my ($iow, $revents) = @_;
1267 # $revents must be 1 here, no need to check 1601 # $revents must be 1 here, no need to check
1268 sysread $term->{socket}, my $buf, 8192 1602 sysread $term->{socket}, my $buf, 8192
1285 1619
1286Set the filedescriptor (not handle) to watch. 1620Set the filedescriptor (not handle) to watch.
1287 1621
1288=item $iow = $iow->events ($eventmask) 1622=item $iow = $iow->events ($eventmask)
1289 1623
1290Set 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
1291data, 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>.
1292 1627
1293=item $iow = $iow->start 1628=item $iow = $iow->start
1294 1629
1295Start watching for requested events on the given handle. 1630Start watching for requested events on the given handle.
1296 1631
1311 1646
1312=item == 0 - fatal messages 1647=item == 0 - fatal messages
1313 1648
1314=item >= 3 - script loading and management 1649=item >= 3 - script loading and management
1315 1650
1316=item >=10 - all events received 1651=item >=10 - all called hooks
1652
1653=item >=11 - hook reutrn values
1317 1654
1318=back 1655=back
1319 1656
1320=head1 AUTHOR 1657=head1 AUTHOR
1321 1658

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines