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.43 by root, Sat Jan 7 04:19:43 2006 UTC vs.
Revision 1.84 by root, Thu Jan 12 02:20:56 2006 UTC

17 17
18 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test 18 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19 19
20=head1 DESCRIPTION 20=head1 DESCRIPTION
21 21
22Everytime a terminal object gets created, scripts specified via the 22Everytime a terminal object gets created, extension scripts specified via
23C<perl> resource are loaded and associated with it. 23the C<perl> resource are loaded and associated with it.
24 24
25Scripts are compiled in a 'use strict' and 'use utf8' environment, and 25Scripts are compiled in a 'use strict' and 'use utf8' environment, and
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 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). Right now, it tries to
46urls and complete shell-quoted arguments, which is very convenient, too, 46select urls and complete shell-quoted arguments, which is very convenient,
47if your F<ls> supports C<--quoting-style=shell>. 47too, if your F<ls> supports C<--quoting-style=shell>.
48 48
49It also offers the following bindable event: 49It also offers the following bindable keyboard command:
50 50
51=over 4 51=over 4
52 52
53=item rot13 53=item rot13
54 54
56 56
57 URxvt.keysym.C-M-r: perl:selection:rot13 57 URxvt.keysym.C-M-r: perl:selection:rot13
58 58
59=back 59=back
60 60
61=item option-popup (enabled by default)
62
63Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
64runtime.
65
66=item selection-popup (enabled by default)
67
68Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69text into various other formats/action (such as uri unescaping, perl
70evalution, web-browser starting etc.), depending on content.
71
72=item searchable-scrollback<hotkey> (enabled by default)
73
74Adds regex search functionality to the scrollback buffer, triggered
75by a hotkey (default: C<M-s>). When in search mode, normal terminal
76input/output is suspended.
77
78C</> starts an incremental regex search, C<n> searches further, C<p> or
79C<N> jump to the previous match, C<G> jumps to the bottom and clears the
80history, C<enter> leaves search mode at the current position and C<escape>
81returns to the original position.
82
61=item digital-clock 83=item digital-clock
62 84
63Displays a digital clock using the built-in overlay. 85Displays a digital clock using the built-in overlay.
64 86
65=item mark-urls 87=item mark-urls
66 88
67Uses per-line display filtering (C<on_line_update>) to underline urls. 89Uses per-line display filtering (C<on_line_update>) to underline urls and
90make them clickable. When middle-clicked, the program specified in the
91resource C<urlLauncher> (default C<x-www-browser>) will be started.
68 92
69=item block-graphics-to-ascii 93=item block-graphics-to-ascii
70 94
71A not very useful example of filtering all text output to the terminal, 95A not very useful example of filtering all text output to the terminal,
72by replacing all line-drawing characters (U+2500 .. U+259F) by a 96by replacing all line-drawing characters (U+2500 .. U+259F) by a
77Displays a very simple digital clock in the upper right corner of the 101Displays a very simple digital clock in the upper right corner of the
78window. Illustrates overwriting the refresh callbacks to create your own 102window. Illustrates overwriting the refresh callbacks to create your own
79overlays or changes. 103overlays or changes.
80 104
81=back 105=back
106
107=head1 API DOCUMENTATION
82 108
83=head2 General API Considerations 109=head2 General API Considerations
84 110
85All objects (such as terminals, time watchers etc.) are typical 111All objects (such as terminals, time watchers etc.) are typical
86reference-to-hash objects. The hash can be used to store anything you 112reference-to-hash objects. The hash can be used to store anything you
99=over 4 125=over 4
100 126
101=item $text 127=item $text
102 128
103Rxvt-unicodes special way of encoding text, where one "unicode" character 129Rxvt-unicodes special way of encoding text, where one "unicode" character
104always represents one screen cell. See L<row_t> for a discussion of this format. 130always represents one screen cell. See L<ROW_t> for a discussion of this format.
105 131
106=item $string 132=item $string
107 133
108A perl text string, with an emphasis on I<text>. It can store all unicode 134A perl text string, with an emphasis on I<text>. It can store all unicode
109characters and is to be distinguished with text encoded in a specific 135characters and is to be distinguished with text encoded in a specific
114Either binary data or - more common - a text string encoded in a 140Either binary data or - more common - a text string encoded in a
115locale-specific way. 141locale-specific way.
116 142
117=back 143=back
118 144
145=head2 Extension Objects
146
147Very perl extension is a perl class. A separate perl object is created
148for each terminal and each extension and passed as the first parameter to
149hooks. So extensions can use their C<$self> object without having to think
150about other extensions, with the exception of methods and members that
151begin with an underscore character C<_>: these are reserved for internal
152use.
153
154Although it isn't a C<urxvt::term> object, you can call all methods of the
155C<urxvt::term> class on this object.
156
157It has the following methods and data members:
158
159=over 4
160
161=item $urxvt_term = $self->{term}
162
163Returns the C<urxvt::term> object associated with this instance of the
164extension. This member I<must not> be changed in any way.
165
166=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
167
168Dynamically enable the given hooks (named without the C<on_> prefix) for
169this extension, replacing any previous hook. This is useful when you want
170to overwrite time-critical hooks only temporarily.
171
172=item $self->disable ($hook_name[, $hook_name..])
173
174Dynamically disable the given hooks.
175
176=back
177
119=head2 Hooks 178=head2 Hooks
120 179
121The following subroutines can be declared in extension files, and will be 180The following subroutines can be declared in extension files, and will be
122called whenever the relevant event happens. 181called whenever the relevant event happens.
123 182
124The first argument passed to them is an object private to each terminal 183The first argument passed to them is an extension oject as described in
125and extension package. You can call all C<urxvt::term> methods on it, but 184the in the C<Extension Objects> section.
126its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
127object that is shared between all packages is stored in the C<term>
128member.
129 185
130All of them must return a boolean value. If it is true, then the event 186B<All> of these hooks must return a boolean value. If it is true, then the
131counts as being I<consumed>, and the invocation of other hooks is skipped, 187event counts as being I<consumed>, and the invocation of other hooks is
132and the relevant action might not be carried out by the C++ code. 188skipped, and the relevant action might not be carried out by the C++ code.
133 189
134When in doubt, return a false value (preferably C<()>). 190I<< When in doubt, return a false value (preferably C<()>). >>
135 191
136=over 4 192=over 4
137 193
138=item on_init $term 194=item on_init $term
139 195
178should extend the selection itelf and return true to suppress the built-in 234should extend the selection itelf and return true to suppress the built-in
179processing. 235processing.
180 236
181See the F<selection> example extension. 237See the F<selection> example extension.
182 238
183=item on_focus_in $term
184
185Called whenever the window gets the keyboard focus, before urxvt does
186focus in processing.
187
188=item on_focus_out $term
189
190Called wheneever the window loses keyboard focus, before urxvt does focus
191out processing.
192
193=item on_view_change $term, $offset 239=item on_view_change $term, $offset
194 240
195Called whenever the view offset changes, i..e the user or program 241Called whenever the view offset changes, i..e the user or program
196scrolls. Offset C<0> means display the normal terminal, positive values 242scrolls. Offset C<0> means display the normal terminal, positive values
197show this many lines of scrollback. 243show this many lines of scrollback.
203than the scroll back buffer or the terminal. 249than the scroll back buffer or the terminal.
204 250
205It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 251It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
206$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 252$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
207number of lines that will be in the scrollback buffer. 253number of lines that will be in the scrollback buffer.
208
209=item on_tty_activity $term *NYI*
210
211Called whenever the program(s) running in the urxvt window send output.
212 254
213=item on_osc_seq $term, $string 255=item on_osc_seq $term, $string
214 256
215Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 257Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
216operating system command) is processed. Cursor position and other state 258operating system command) is processed. Cursor position and other state
229can filter/change and output the text yourself by returning a true value 271can filter/change and output the text yourself by returning a true value
230and calling C<< $term->scr_add_lines >> yourself. Please note that this 272and calling C<< $term->scr_add_lines >> yourself. Please note that this
231might be very slow, however, as your hook is called for B<all> text being 273might be very slow, however, as your hook is called for B<all> text being
232output. 274output.
233 275
276=item on_tt_write $term, $octets
277
278Called whenever some data is written to the tty/pty and can be used to
279suppress or filter tty input.
280
234=item on_line_update $term, $row 281=item on_line_update $term, $row
235 282
236Called whenever a line was updated or changed. Can be used to filter 283Called whenever a line was updated or changed. Can be used to filter
237screen output (e.g. underline urls or other useless stuff). Only lines 284screen output (e.g. underline urls or other useless stuff). Only lines
238that are being shown will be filtered, and, due to performance reasons, 285that are being shown will be filtered, and, due to performance reasons,
260 307
261Called whenever the user presses a key combination that has a 308Called whenever the user presses a key combination that has a
262C<perl:string> action bound to it (see description of the B<keysym> 309C<perl:string> action bound to it (see description of the B<keysym>
263resource in the @@RXVT_NAME@@(1) manpage). 310resource in the @@RXVT_NAME@@(1) manpage).
264 311
312=item on_focus_in $term
313
314Called whenever the window gets the keyboard focus, before rxvt-unicode
315does focus in processing.
316
317=item on_focus_out $term
318
319Called wheneever the window loses keyboard focus, before rxvt-unicode does
320focus out processing.
321
265=item on_key_press $term, $event, $octets 322=item on_key_press $term, $event, $keysym, $octets
266 323
267=item on_key_release $term, $event 324=item on_key_release $term, $event, $keysym
268 325
269=item on_button_press $term, $event 326=item on_button_press $term, $event
270 327
271=item on_button_release $term, $event 328=item on_button_release $term, $event
272 329
273=item on_motion_notify $term, $event 330=item on_motion_notify $term, $event
331
332=item on_map_notify $term, $event
333
334=item on_unmap_notify $term, $event
274 335
275Called whenever the corresponding X event is received for the terminal If 336Called whenever the corresponding X event is received for the terminal If
276the hook returns true, then the even will be ignored by rxvt-unicode. 337the hook returns true, then the even will be ignored by rxvt-unicode.
277 338
278The event is a hash with most values as named by Xlib (see the XEvent 339The event is a hash with most values as named by Xlib (see the XEvent
284 345
285subwindow. 346subwindow.
286 347
287=back 348=back
288 349
350=cut
351
352package urxvt;
353
354use utf8;
355use strict;
356use Carp ();
357use Scalar::Util ();
358use List::Util ();
359
360our $VERSION = 1;
361our $TERM;
362our @HOOKNAME;
363our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
364our %OPTION;
365
366our $LIBDIR;
367our $RESNAME;
368our $RESCLASS;
369our $RXVTNAME;
370
289=head2 Variables in the C<urxvt> Package 371=head2 Variables in the C<urxvt> Package
290 372
291=over 4 373=over 4
374
375=item $urxvt::LIBDIR
376
377The rxvt-unicode library directory, where, among other things, the perl
378modules and scripts are stored.
379
380=item $urxvt::RESCLASS, $urxvt::RESCLASS
381
382The resource class and name rxvt-unicode uses to look up X resources.
383
384=item $urxvt::RXVTNAME
385
386The basename of the installed binaries, usually C<urxvt>.
292 387
293=item $urxvt::TERM 388=item $urxvt::TERM
294 389
295The current terminal. This variable stores the current C<urxvt::term> 390The current terminal. This variable stores the current C<urxvt::term>
296object, whenever a callback/hook is executing. 391object, whenever a callback/hook is executing.
298=back 393=back
299 394
300=head2 Functions in the C<urxvt> Package 395=head2 Functions in the C<urxvt> Package
301 396
302=over 4 397=over 4
303
304=item $term = new urxvt [arg...]
305
306Creates a new terminal, very similar as if you had started it with
307C<system $binfile, arg...>. Croaks (and probably outputs an error message)
308if the new instance couldn't be created. Returns C<undef> if the new
309instance didn't initialise perl, and the terminal object otherwise. The
310C<init> and C<start> hooks will be called during the call.
311 398
312=item urxvt::fatal $errormessage 399=item urxvt::fatal $errormessage
313 400
314Fatally aborts execution with the given error message. Avoid at all 401Fatally aborts execution with the given error message. Avoid at all
315costs! The only time this is acceptable is when the terminal process 402costs! The only time this is acceptable is when the terminal process
322that calls this function. 409that calls this function.
323 410
324Using this function has the advantage that its output ends up in the 411Using this function has the advantage that its output ends up in the
325correct place, e.g. on stderr of the connecting urxvtc client. 412correct place, e.g. on stderr of the connecting urxvtc client.
326 413
414Messages have a size limit of 1023 bytes currently.
415
416=item $is_safe = urxvt::safe
417
418Returns true when it is safe to do potentially unsafe things, such as
419evaluating perl code specified by the user. This is true when urxvt was
420started setuid or setgid.
421
327=item $time = urxvt::NOW 422=item $time = urxvt::NOW
328 423
329Returns the "current time" (as per the event loop). 424Returns the "current time" (as per the event loop).
425
426=item urxvt::CurrentTime
427
428=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
429Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
430Button4Mask, Button5Mask, AnyModifier
431
432Various constants for use in X calls and event processing.
330 433
331=back 434=back
332 435
333=head2 RENDITION 436=head2 RENDITION
334 437
361 464
362=item $background = urxvt::GET_BASEBG $rend 465=item $background = urxvt::GET_BASEBG $rend
363 466
364Return the foreground/background colour index, respectively. 467Return the foreground/background colour index, respectively.
365 468
366=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) 469=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
367 470
368=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) 471=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
369 472
370Replace the foreground/background colour in the rendition mask with the 473Replace the foreground/background colour in the rendition mask with the
371specified one. 474specified one.
372 475
373=item $value = urxvt::GET_CUSTOM ($rend) 476=item $value = urxvt::GET_CUSTOM $rend
374 477
375Return the "custom" value: Every rendition has 5 bits for use by 478Return the "custom" value: Every rendition has 5 bits for use by
376extensions. They can be set and changed as you like and are initially 479extensions. They can be set and changed as you like and are initially
377zero. 480zero.
378 481
379=item $rend = urxvt::SET_CUSTOM ($rend, $new_value) 482=item $rend = urxvt::SET_CUSTOM $rend, $new_value
380 483
381Change the custom value. 484Change the custom value.
382 485
383=back 486=back
384 487
385=cut 488=cut
386
387package urxvt;
388
389use strict;
390use Scalar::Util ();
391
392our $TERM;
393our @HOOKNAME;
394our $LIBDIR;
395 489
396BEGIN { 490BEGIN {
397 urxvt->bootstrap; 491 urxvt->bootstrap;
398 492
399 # overwrite perl's warn 493 # overwrite perl's warn
401 my $msg = join "", @_; 495 my $msg = join "", @_;
402 $msg .= "\n" 496 $msg .= "\n"
403 unless $msg =~ /\n$/; 497 unless $msg =~ /\n$/;
404 urxvt::warn ($msg); 498 urxvt::warn ($msg);
405 }; 499 };
500
501 # %ENV is the original startup environment
502 delete $ENV{IFS};
503 delete $ENV{CDPATH};
504 delete $ENV{BASH_ENV};
505 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
406} 506}
407 507
408my @hook_count; 508my @hook_count;
409my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 509my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
410 510
411sub verbose { 511sub verbose {
412 my ($level, $msg) = @_; 512 my ($level, $msg) = @_;
413 warn "$msg\n" if $level <= $verbosity; 513 warn "$msg\n" if $level <= $verbosity;
414} 514}
415 515
416# find on_xxx subs in the package and register them 516my $extension_pkg = "extension0000";
417# as hooks 517my %extension_pkg;
418sub register_package($) {
419 my ($pkg) = @_;
420
421 for my $htype (0.. $#HOOKNAME) {
422 my $name = $HOOKNAME[$htype];
423
424 my $ref = $pkg->can ("on_" . lc $name)
425 or next;
426
427 $TERM->{_hook}[$htype]{$pkg} = $ref;
428 $hook_count[$htype]++
429 or set_should_invoke $htype, 1;
430 }
431}
432
433my $script_pkg = "script0000";
434my %script_pkg;
435 518
436# load a single script into its own package, once only 519# load a single script into its own package, once only
437sub script_package($) { 520sub extension_package($) {
438 my ($path) = @_; 521 my ($path) = @_;
439 522
440 $script_pkg{$path} ||= do { 523 $extension_pkg{$path} ||= do {
441 my $pkg = "urxvt::" . ($script_pkg++); 524 my $pkg = "urxvt::" . ($extension_pkg++);
442 525
443 verbose 3, "loading script '$path' into package '$pkg'"; 526 verbose 3, "loading extension '$path' into package '$pkg'";
444 527
445 open my $fh, "<:raw", $path 528 open my $fh, "<:raw", $path
446 or die "$path: $!"; 529 or die "$path: $!";
447 530
531 my $source = untaint
448 my $source = "package $pkg; use strict; use utf8;\n" 532 "package $pkg; use strict; use utf8;\n"
533 . "use base urxvt::term::extension::;\n"
449 . "#line 1 \"$path\"\n{\n" 534 . "#line 1 \"$path\"\n{\n"
450 . (do { local $/; <$fh> }) 535 . (do { local $/; <$fh> })
451 . "\n};\n1"; 536 . "\n};\n1";
452 537
538 eval $source
453 eval $source or die "$path: $@"; 539 or die "$path: $@";
454 540
455 $pkg 541 $pkg
456 } 542 }
457} 543}
458 544
463 local $TERM = shift; 549 local $TERM = shift;
464 my $htype = shift; 550 my $htype = shift;
465 551
466 if ($htype == 0) { # INIT 552 if ($htype == 0) { # INIT
467 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 553 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
554
555 my %ext_arg;
468 556
469 for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 557 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
558 if ($_ eq "default") {
559 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
560 } elsif (/^-(.*)$/) {
561 delete $ext_arg{$1};
562 } elsif (/^([^<]+)<(.*)>$/) {
563 push @{ $ext_arg{$1} }, $2;
564 } else {
565 $ext_arg{$_} ||= [];
566 }
567 }
568
569 while (my ($ext, $argv) = each %ext_arg) {
470 my @files = grep -f $_, map "$_/$ext", @dirs; 570 my @files = grep -f $_, map "$_/$ext", @dirs;
471 571
472 if (@files) { 572 if (@files) {
473 register_package script_package $files[0]; 573 $TERM->register_package (extension_package $files[0], $argv);
474 } else { 574 } else {
475 warn "perl extension '$ext' not found in perl library search path\n"; 575 warn "perl extension '$ext' not found in perl library search path\n";
476 } 576 }
477 } 577 }
578
579 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
580 warn $@ if $@;
478 } 581 }
479 582
480 $retval = undef; 583 $retval = undef;
481 584
482 if (my $cb = $TERM->{_hook}[$htype]) { 585 if (my $cb = $TERM->{_hook}[$htype]) {
484 if $verbosity >= 10; 587 if $verbosity >= 10;
485 588
486 keys %$cb; 589 keys %$cb;
487 590
488 while (my ($pkg, $cb) = each %$cb) { 591 while (my ($pkg, $cb) = each %$cb) {
489 $retval = $cb->( 592 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
490 $TERM->{_pkg}{$pkg} ||= do {
491 my $proxy = bless { }, urxvt::term::proxy::;
492 Scalar::Util::weaken ($proxy->{term} = $TERM);
493 $proxy
494 },
495 @_,
496 ) and last; 593 and last;
594
595 if ($@) {
596 $TERM->ungrab; # better to lose the grab than the session
597 warn $@;
598 }
497 } 599 }
498 } 600 }
499 601
500 if ($htype == 1) { # DESTROY 602 if ($htype == 1) { # DESTROY
501 # remove hooks if unused
502 if (my $hook = $TERM->{_hook}) { 603 if (my $hook = delete $TERM->{_hook}) {
503 for my $htype (0..$#$hook) { 604 for my $htype (0..$#$hook) {
504 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } 605 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
505 or set_should_invoke $htype, 0; 606 or set_should_invoke $htype, 0;
506 } 607 }
507 } 608 }
514 } 615 }
515 616
516 $retval 617 $retval
517} 618}
518 619
519sub urxvt::term::proxy::AUTOLOAD { 620sub exec_async(@) {
520 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 621 my $pid = fork;
622
623 return
624 if !defined $pid or $pid;
625
626 %ENV = %{ $TERM->env };
627
628 exec @_;
629 _exit 255;
630}
631
632# urxvt::term::extension
633
634package urxvt::term::extension;
635
636sub enable {
637 my ($self, %hook) = @_;
638 my $pkg = $self->{_pkg};
639
640 while (my ($name, $cb) = each %hook) {
641 my $htype = $HOOKTYPE{uc $name};
642 defined $htype
643 or Carp::croak "unsupported hook type '$name'";
644
645 unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
646 $hook_count[$htype]++
647 or urxvt::set_should_invoke $htype, 1;
648 }
649
650 $self->{term}{_hook}[$htype]{$pkg} = $cb;
651 }
652}
653
654sub disable {
655 my ($self, @hook) = @_;
656 my $pkg = $self->{_pkg};
657
658 for my $name (@hook) {
659 my $htype = $HOOKTYPE{uc $name};
660 defined $htype
661 or Carp::croak "unsupported hook type '$name'";
662
663 if (delete $self->{term}{_hook}[$htype]{$pkg}) {
664 --$hook_count[$htype]
665 or urxvt::set_should_invoke $htype, 0;
666 }
667 }
668}
669
670our $AUTOLOAD;
671
672sub AUTOLOAD {
673 $AUTOLOAD =~ /:([^:]+)$/
521 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 674 or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
522 675
523 eval qq{ 676 eval qq{
524 sub $urxvt::term::proxy::AUTOLOAD { 677 sub $AUTOLOAD {
525 my \$proxy = shift; 678 my \$proxy = shift;
526 \$proxy->{term}->$1 (\@_) 679 \$proxy->{term}->$1 (\@_)
527 } 680 }
528 1 681 1
529 } or die "FATAL: unable to compile method forwarder: $@"; 682 } or die "FATAL: unable to compile method forwarder: $@";
530 683
531 goto &$urxvt::term::proxy::AUTOLOAD; 684 goto &$AUTOLOAD;
532} 685}
686
687sub DESTROY {
688 # nop
689}
690
691# urxvt::destroy_hook
692
693sub urxvt::destroy_hook::DESTROY {
694 ${$_[0]}->();
695}
696
697sub urxvt::destroy_hook(&) {
698 bless \shift, urxvt::destroy_hook::
699}
700
701package urxvt::anyevent;
702
703=head2 The C<urxvt::anyevent> Class
704
705The sole purpose of this class is to deliver an interface to the
706C<AnyEvent> module - any module using it will work inside urxvt without
707further programming. The only exception is that you cannot wait on
708condition variables, but non-blocking condvar use is ok. What this means
709is that you cannot use blocking APIs, but the non-blocking variant should
710work.
711
712=cut
713
714our $VERSION = 1;
715
716$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
717push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
718
719sub timer {
720 my ($class, %arg) = @_;
721
722 my $cb = $arg{cb};
723
724 urxvt::timer
725 ->new
726 ->start (urxvt::NOW + $arg{after})
727 ->cb (sub {
728 $_[0]->stop; # need to cancel manually
729 $cb->();
730 })
731}
732
733sub io {
734 my ($class, %arg) = @_;
735
736 my $cb = $arg{cb};
737
738 bless [$arg{fh}, urxvt::iow
739 ->new
740 ->fd (fileno $arg{fh})
741 ->events (($arg{poll} =~ /r/ ? 1 : 0)
742 | ($arg{poll} =~ /w/ ? 2 : 0))
743 ->start
744 ->cb (sub {
745 $cb->(($_[1] & 1 ? 'r' : '')
746 . ($_[1] & 2 ? 'w' : ''));
747 })],
748 urxvt::anyevent::
749}
750
751sub DESTROY {
752 $_[0][1]->stop;
753}
754
755sub condvar {
756 bless \my $flag, urxvt::anyevent::condvar::
757}
758
759sub urxvt::anyevent::condvar::broadcast {
760 ${$_[0]}++;
761}
762
763sub urxvt::anyevent::condvar::wait {
764 unless (${$_[0]}) {
765 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
766 }
767}
768
769package urxvt::term;
533 770
534=head2 The C<urxvt::term> Class 771=head2 The C<urxvt::term> Class
535 772
536=over 4 773=over 4
537 774
775=cut
776
777# find on_xxx subs in the package and register them
778# as hooks
779sub register_package {
780 my ($self, $pkg, $argv) = @_;
781
782 my $proxy = bless {
783 _pkg => $pkg,
784 argv => $argv,
785 }, $pkg;
786 Scalar::Util::weaken ($proxy->{term} = $self);
787
788 $self->{_pkg}{$pkg} = $proxy;
789
790 for my $name (@HOOKNAME) {
791 if (my $ref = $pkg->can ("on_" . lc $name)) {
792 $proxy->enable ($name => $ref);
793 }
794 }
795}
796
797=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
798
799Creates a new terminal, very similar as if you had started it with system
800C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
801hash which defines the environment of the new terminal.
802
803Croaks (and probably outputs an error message) if the new instance
804couldn't be created. Returns C<undef> if the new instance didn't
805initialise perl, and the terminal object otherwise. The C<init> and
806C<start> hooks will be called during this call.
807
808=cut
809
810sub new {
811 my ($class, $env, @args) = @_;
812
813 _new ([ map "$_=$env->{$_}", keys %$env ], @args);
814}
815
538=item $term->destroy 816=item $term->destroy
539 817
540Destroy the terminal object (close the window, free resources etc.). 818Destroy the terminal object (close the window, free resources
819etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
820watchers (timers, io watchers) are still active.
821
822=item $isset = $term->option ($optval[, $set])
823
824Returns true if the option specified by C<$optval> is enabled, and
825optionally change it. All option values are stored by name in the hash
826C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
827
828Here is a a likely non-exhaustive list of option names, please see the
829source file F</src/optinc.h> to see the actual list:
830
831 borderLess console cursorBlink cursorUnderline hold iconic insecure
832 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
833 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
834 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
835 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
836 tripleclickwords utmpInhibit visualBell
541 837
542=item $value = $term->resource ($name[, $newval]) 838=item $value = $term->resource ($name[, $newval])
543 839
544Returns the current resource value associated with a given name and 840Returns the current resource value associated with a given name and
545optionally sets a new value. Setting values is most useful in the C<init> 841optionally sets a new value. Setting values is most useful in the C<init>
555 851
556Please note that resource strings will currently only be freed when the 852Please note that resource strings will currently only be freed when the
557terminal is destroyed, so changing options frequently will eat memory. 853terminal is destroyed, so changing options frequently will eat memory.
558 854
559Here is a a likely non-exhaustive list of resource names, not all of which 855Here is a a likely non-exhaustive list of resource names, not all of which
560are supported in every build, please see the source to see the actual 856are supported in every build, please see the source file F</src/rsinc.h>
561list: 857to see the actual list:
562 858
563 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 859 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
564 borderLess color cursorBlink cursorUnderline cutchars delete_key 860 borderLess color cursorBlink cursorUnderline cutchars delete_key
565 display_name embed ext_bwidth fade font geometry hold iconName 861 display_name embed ext_bwidth fade font geometry hold iconName
566 imFont imLocale inputMethod insecure int_bwidth intensityStyles 862 imFont imLocale inputMethod insecure int_bwidth intensityStyles
573 shade term_name title transparent transparent_all tripleclickwords 869 shade term_name title transparent transparent_all tripleclickwords
574 utmpInhibit visualBell 870 utmpInhibit visualBell
575 871
576=cut 872=cut
577 873
578sub urxvt::term::resource($$;$) { 874sub resource($$;$) {
579 my ($self, $name) = (shift, shift); 875 my ($self, $name) = (shift, shift);
580 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 876 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
581 goto &urxvt::term::_resource; 877 &urxvt::term::_resource
582} 878}
879
880=item $value = $term->x_resource ($pattern)
881
882Returns the X-Resource for the given pattern, excluding the program or
883class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
884same value as used by this instance of rxvt-unicode. Returns C<undef> if no
885resource with that pattern exists.
886
887This method should only be called during the C<on_start> hook, as there is
888only one resource database per display, and later invocations might return
889the wrong resources.
890
891=item $success = $term->parse_keysym ($keysym_spec, $command_string)
892
893Adds a keymap translation exactly as specified via a resource. See the
894C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
583 895
584=item $rend = $term->rstyle ([$new_rstyle]) 896=item $rend = $term->rstyle ([$new_rstyle])
585 897
586Return and optionally change the current rendition. Text that is output by 898Return and optionally change the current rendition. Text that is output by
587the terminal application will use this style. 899the terminal application will use this style.
607 919
608=item $oldtext = $term->selection ([$newtext]) 920=item $oldtext = $term->selection ([$newtext])
609 921
610Return the current selection text and optionally replace it by C<$newtext>. 922Return the current selection text and optionally replace it by C<$newtext>.
611 923
612#=item $term->overlay ($x, $y, $text) 924=item $term->overlay_simple ($x, $y, $text)
613# 925
614#Create a simple multi-line overlay box. See the next method for details. 926Create a simple multi-line overlay box. See the next method for details.
615# 927
616#=cut 928=cut
617# 929
618#sub urxvt::term::scr_overlay { 930sub overlay_simple {
619# my ($self, $x, $y, $text) = @_; 931 my ($self, $x, $y, $text) = @_;
620# 932
621# my @lines = split /\n/, $text; 933 my @lines = split /\n/, $text;
622# 934
623# my $w = 0; 935 my $w = List::Util::max map $self->strwidth ($_), @lines;
624# for (map $self->strwidth ($_), @lines) { 936
625# $w = $_ if $w < $_;
626# }
627#
628# $self->scr_overlay_new ($x, $y, $w, scalar @lines); 937 my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
629# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; 938 $overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
630#} 939
940 $overlay
941}
631 942
632=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) 943=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
633 944
634Create a new (empty) overlay at the given position with the given 945Create a new (empty) overlay at the given position with the given
635width/height. C<$rstyle> defines the initial rendition style 946width/height. C<$rstyle> defines the initial rendition style
662 973
663If hidden, display the overlay again. 974If hidden, display the overlay again.
664 975
665=back 976=back
666 977
978=item $popup = $term->popup ($event)
979
980Creates a new C<urxvt::popup> object that implements a popup menu. The
981C<$event> I<must> be the event causing the menu to pop up (a button event,
982currently).
983
984=cut
985
986sub popup {
987 my ($self, $event) = @_;
988
989 $self->grab ($event->{time}, 1)
990 or return;
991
992 my $popup = bless {
993 term => $self,
994 event => $event,
995 }, urxvt::popup::;
996
997 Scalar::Util::weaken $popup->{term};
998
999 $self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
1000 Scalar::Util::weaken $self->{_destroy}{$popup};
1001
1002 $popup
1003}
1004
667=item $cellwidth = $term->strwidth ($string) 1005=item $cellwidth = $term->strwidth ($string)
668 1006
669Returns the number of screen-cells this string would need. Correctly 1007Returns the number of screen-cells this string would need. Correctly
670accounts for wide and combining characters. 1008accounts for wide and combining characters.
671 1009
674Convert the given text string into the corresponding locale encoding. 1012Convert the given text string into the corresponding locale encoding.
675 1013
676=item $string = $term->locale_decode ($octets) 1014=item $string = $term->locale_decode ($octets)
677 1015
678Convert the given locale-encoded octets into a perl string. 1016Convert the given locale-encoded octets into a perl string.
1017
1018=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1019
1020XORs the rendition values in the given span with the provided value
1021(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
1022to the selection.
1023
1024=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1025
1026Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1027whitespace will additionally be xored with the C<$rstyle2>, which defaults
1028to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1029it instead.
1030
1031=item $term->scr_bell
1032
1033Ring the bell!
679 1034
680=item $term->scr_add_lines ($string) 1035=item $term->scr_add_lines ($string)
681 1036
682Write the given text string to the screen, as if output by the application 1037Write the given text string to the screen, as if output by the application
683running inside the terminal. It may not contain command sequences (escape 1038running inside the terminal. It may not contain command sequences (escape
698 1053
699Write the octets given in C<$data> to the tty (i.e. as program input). To 1054Write the octets given in C<$data> to the tty (i.e. as program input). To
700pass characters instead of octets, you should convert your strings first 1055pass characters instead of octets, you should convert your strings first
701to the locale-specific encoding using C<< $term->locale_encode >>. 1056to the locale-specific encoding using C<< $term->locale_encode >>.
702 1057
1058=item $old_events = $term->pty_ev_events ([$new_events])
1059
1060Replaces the event mask of the pty watcher by the given event mask. Can
1061be used to suppress input and output handling to the pty/tty. See the
1062description of C<< urxvt::timer->events >>. Make sure to always restore
1063the previous value.
1064
703=item $windowid = $term->parent 1065=item $windowid = $term->parent
704 1066
705Return the window id of the toplevel window. 1067Return the window id of the toplevel window.
706 1068
707=item $windowid = $term->vt 1069=item $windowid = $term->vt
731=item $nrow_plus_saveLines = $term->total_rows 1093=item $nrow_plus_saveLines = $term->total_rows
732 1094
733=item $lines_in_scrollback = $term->nsaved 1095=item $lines_in_scrollback = $term->nsaved
734 1096
735Return various integers describing terminal characteristics. 1097Return various integers describing terminal characteristics.
1098
1099=item $x_display = $term->display_id
1100
1101Return the DISPLAY used by rxvt-unicode.
1102
1103=item $lc_ctype = $term->locale
1104
1105Returns the LC_CTYPE category string used by this rxvt-unicode.
1106
1107=item $env = $term->env
1108
1109Returns a copy of the environment in effect for the terminal as a hashref
1110similar to C<\%ENV>.
1111
1112=cut
1113
1114sub env {
1115 if (my $env = $_[0]->_env) {
1116 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
1117 } else {
1118 +{ %ENV }
1119 }
1120}
1121
1122=item $modifiermask = $term->ModLevel3Mask
1123
1124=item $modifiermask = $term->ModMetaMask
1125
1126=item $modifiermask = $term->ModNumLockMask
1127
1128Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1129AltGr), the meta key (often Alt) and the num lock key, if applicable.
736 1130
737=item $view_start = $term->view_start ([$newvalue]) 1131=item $view_start = $term->view_start ([$newvalue])
738 1132
739Returns the negative row number of the topmost line. Minimum value is 1133Returns the negative row number of the topmost line. Minimum value is
740C<0>, which displays the normal terminal contents. Larger values scroll 1134C<0>, which displays the normal terminal contents. Larger values scroll
834 1228
835=back 1229=back
836 1230
837=cut 1231=cut
838 1232
839sub urxvt::term::line { 1233sub line {
840 my ($self, $row) = @_; 1234 my ($self, $row) = @_;
841 1235
842 my $maxrow = $self->nrow - 1; 1236 my $maxrow = $self->nrow - 1;
843 1237
844 my ($beg, $end) = ($row, $row); 1238 my ($beg, $end) = ($row, $row);
908 $offset / $self->{ncol} + $self->{beg}, 1302 $offset / $self->{ncol} + $self->{beg},
909 $offset % $self->{ncol} 1303 $offset % $self->{ncol}
910 ) 1304 )
911} 1305}
912 1306
913=item ($row, $col) = $line->coord_of ($offset)
914=item $text = $term->special_encode $string 1307=item $text = $term->special_encode $string
915 1308
916Converts a perl string into the special encoding used by rxvt-unicode, 1309Converts a perl string into the special encoding used by rxvt-unicode,
917where one character corresponds to one screen cell. See 1310where one character corresponds to one screen cell. See
918C<< $term->ROW_t >> for details. 1311C<< $term->ROW_t >> for details.
919 1312
920=item $string = $term->special_decode $text 1313=item $string = $term->special_decode $text
921 1314
922Converts rxvt-unicodes text reprsentation into a perl string. See 1315Converts rxvt-unicodes text reprsentation into a perl string. See
923C<< $term->ROW_t >> for details. 1316C<< $term->ROW_t >> for details.
1317
1318=item $success = $term->grab_button ($button, $modifiermask)
1319
1320Registers a synchronous button grab. See the XGrabButton manpage.
1321
1322=item $success = $term->grab ($eventtime[, $sync])
1323
1324Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1325synchronous (C<$sync> is true). Also remembers the grab timestampe.
1326
1327=item $term->allow_events_async
1328
1329Calls XAllowEvents with AsyncBoth for the most recent grab.
1330
1331=item $term->allow_events_sync
1332
1333Calls XAllowEvents with SyncBoth for the most recent grab.
1334
1335=item $term->allow_events_replay
1336
1337Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1338recent grab.
1339
1340=item $term->ungrab
1341
1342Calls XUngrab for the most recent grab. Is called automatically on
1343evaluation errors, as it is better to lose the grab in the error case as
1344the session.
1345
1346=back
1347
1348=cut
1349
1350package urxvt::popup;
1351
1352=head2 The C<urxvt::popup> Class
1353
1354=over 4
1355
1356=cut
1357
1358sub add_item {
1359 my ($self, $item) = @_;
1360
1361 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
1362 $item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
1363 $item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
1364
1365 $item->{render} ||= sub { $_[0]{text} };
1366
1367 push @{ $self->{item} }, $item;
1368}
1369
1370=item $popup->add_title ($title)
1371
1372Adds a non-clickable title to the popup.
1373
1374=cut
1375
1376sub add_title {
1377 my ($self, $title) = @_;
1378
1379 $self->add_item ({
1380 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
1381 text => $title,
1382 activate => sub { },
1383 });
1384}
1385
1386=item $popup->add_separator ([$sepchr])
1387
1388Creates a separator, optionally using the character given as C<$sepchr>.
1389
1390=cut
1391
1392sub add_separator {
1393 my ($self, $sep) = @_;
1394
1395 $sep ||= "=";
1396
1397 $self->add_item ({
1398 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1399 text => "",
1400 render => sub { $sep x $self->{term}->ncol },
1401 activate => sub { },
1402 });
1403}
1404
1405=item $popup->add_button ($text, $cb)
1406
1407Adds a clickable button to the popup. C<$cb> is called whenever it is
1408selected.
1409
1410=cut
1411
1412sub add_button {
1413 my ($self, $text, $cb) = @_;
1414
1415 $self->add_item ({ type => "button", text => $text, activate => $cb});
1416}
1417
1418=item $popup->add_toggle ($text, $cb, $initial_value)
1419
1420Adds a toggle/checkbox item to the popup. Teh callback gets called
1421whenever it gets toggled, with a boolean indicating its value as its first
1422argument.
1423
1424=cut
1425
1426sub add_toggle {
1427 my ($self, $text, $cb, $value) = @_;
1428
1429 my $item; $item = {
1430 type => "button",
1431 text => " $text",
1432 value => $value,
1433 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1434 activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1435 };
1436
1437 $self->add_item ($item);
1438}
1439
1440=item $popup->show
1441
1442Displays the popup (which is initially hidden).
1443
1444=cut
1445
1446sub show {
1447 my ($self) = @_;
1448
1449 local $urxvt::popup::self = $self;
1450
1451 my $env = $self->{term}->env;
1452 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1453 delete $env->{LC_ALL};
1454 $env->{LC_CTYPE} = $self->{term}->locale;
1455
1456 urxvt::term->new ($env, $self->{term}->resource ("name"),
1457 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1458 "--transient-for" => $self->{term}->parent,
1459 "-display" => $self->{term}->display_id,
1460 "-pe" => "urxvt-popup")
1461 or die "unable to create popup window\n";
1462}
1463
1464sub DESTROY {
1465 my ($self) = @_;
1466
1467 delete $self->{term}{_destroy}{$self};
1468 $self->{term}->ungrab;
1469}
924 1470
925=back 1471=back
926 1472
927=head2 The C<urxvt::timer> Class 1473=head2 The C<urxvt::timer> Class
928 1474
983 1529
984 $term->{socket} = ... 1530 $term->{socket} = ...
985 $term->{iow} = urxvt::iow 1531 $term->{iow} = urxvt::iow
986 ->new 1532 ->new
987 ->fd (fileno $term->{socket}) 1533 ->fd (fileno $term->{socket})
988 ->events (1) # wait for read data 1534 ->events (urxvt::EVENT_READ)
989 ->start 1535 ->start
990 ->cb (sub { 1536 ->cb (sub {
991 my ($iow, $revents) = @_; 1537 my ($iow, $revents) = @_;
992 # $revents must be 1 here, no need to check 1538 # $revents must be 1 here, no need to check
993 sysread $term->{socket}, my $buf, 8192 1539 sysread $term->{socket}, my $buf, 8192
1010 1556
1011Set the filedescriptor (not handle) to watch. 1557Set the filedescriptor (not handle) to watch.
1012 1558
1013=item $iow = $iow->events ($eventmask) 1559=item $iow = $iow->events ($eventmask)
1014 1560
1015Set the event mask to watch. Bit #0 (value C<1>) enables watching for read 1561Set the event mask to watch. The only allowed values are
1016data, Bit #1 (value C<2>) enables watching for write data. 1562C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
1563together, or C<urxvt::EVENT_NONE>.
1017 1564
1018=item $iow = $iow->start 1565=item $iow = $iow->start
1019 1566
1020Start watching for requested events on the given handle. 1567Start watching for requested events on the given handle.
1021 1568
1032This variable controls the verbosity level of the perl extension. Higher 1579This variable controls the verbosity level of the perl extension. Higher
1033numbers indicate more verbose output. 1580numbers indicate more verbose output.
1034 1581
1035=over 4 1582=over 4
1036 1583
1037=item =0 - only fatal messages 1584=item == 0 - fatal messages
1038 1585
1039=item =3 - script loading and management 1586=item >= 3 - script loading and management
1040 1587
1041=item =10 - all events received 1588=item >=10 - all events received
1042 1589
1043=back 1590=back
1044 1591
1045=head1 AUTHOR 1592=head1 AUTHOR
1046 1593

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines