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.41 by root, Fri Jan 6 20:50:58 2006 UTC vs.
Revision 1.81 by root, Thu Jan 12 00:12:40 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 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 clicked, the program specified in the resource
91C<urlLauncher> (default C<x-www-browser>) will be started.
92
93=item block-graphics-to-ascii
94
95A not very useful example of filtering all text output to the terminal,
96by replacing all line-drawing characters (U+2500 .. U+259F) by a
97similar-looking ascii character.
68 98
69=item example-refresh-hooks 99=item example-refresh-hooks
70 100
71Displays 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
72window. Illustrates overwriting the refresh callbacks to create your own 102window. Illustrates overwriting the refresh callbacks to create your own
73overlays or changes. 103overlays or changes.
74 104
75=item example-filter-input
76
77A not very useful example of filtering all text output to the terminal, by
78underlining all urls that matches a certain regex (i.e. some urls :). It
79is not very useful because urls that are output in multiple steps (e.g.
80when typing them) do not get marked.
81
82=back 105=back
106
107=head1 API DOCUMENTATION
83 108
84=head2 General API Considerations 109=head2 General API Considerations
85 110
86All objects (such as terminals, time watchers etc.) are typical 111All objects (such as terminals, time watchers etc.) are typical
87reference-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
100=over 4 125=over 4
101 126
102=item $text 127=item $text
103 128
104Rxvt-unicodes special way of encoding text, where one "unicode" character 129Rxvt-unicodes special way of encoding text, where one "unicode" character
105always 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.
106 131
107=item $string 132=item $string
108 133
109A 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
110characters and is to be distinguished with text encoded in a specific 135characters and is to be distinguished with text encoded in a specific
115Either binary data or - more common - a text string encoded in a 140Either binary data or - more common - a text string encoded in a
116locale-specific way. 141locale-specific way.
117 142
118=back 143=back
119 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
120=head2 Hooks 178=head2 Hooks
121 179
122The following subroutines can be declared in loaded scripts, and will be 180The following subroutines can be declared in extension files, and will be
123called whenever the relevant event happens. 181called whenever the relevant event happens.
124 182
125The 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
126and extension package. You can call all C<urxvt::term> methods on it, but 184the in the C<Extension Objects> section.
127its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
128object that is shared between all packages is stored in the C<term>
129member.
130 185
131All 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
132counts 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
133and 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.
134 189
135When in doubt, return a false value (preferably C<()>). 190I<< When in doubt, return a false value (preferably C<()>). >>
136 191
137=over 4 192=over 4
138 193
139=item on_init $term 194=item on_init $term
140 195
179should 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
180processing. 235processing.
181 236
182See the F<selection> example extension. 237See the F<selection> example extension.
183 238
184=item on_focus_in $term
185
186Called whenever the window gets the keyboard focus, before urxvt does
187focus in processing.
188
189=item on_focus_out $term
190
191Called wheneever the window loses keyboard focus, before urxvt does focus
192out processing.
193
194=item on_view_change $term, $offset 239=item on_view_change $term, $offset
195 240
196Called whenever the view offset changes, i..e the user or program 241Called whenever the view offset changes, i..e the user or program
197scrolls. Offset C<0> means display the normal terminal, positive values 242scrolls. Offset C<0> means display the normal terminal, positive values
198show this many lines of scrollback. 243show this many lines of scrollback.
204than the scroll back buffer or the terminal. 249than the scroll back buffer or the terminal.
205 250
206It 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,
207$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
208number of lines that will be in the scrollback buffer. 253number 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 254
214=item on_osc_seq $term, $string 255=item on_osc_seq $term, $string
215 256
216Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 257Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
217operating system command) is processed. Cursor position and other state 258operating system command) is processed. Cursor position and other state
230can 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
231and calling C<< $term->scr_add_lines >> yourself. Please note that this 272and 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 273might be very slow, however, as your hook is called for B<all> text being
233output. 274output.
234 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
235=item on_line_update $term, $row 281=item on_line_update $term, $row
236 282
237Called 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
238screen output (e.g. underline urls or other useless stuff). Only lines 284screen output (e.g. underline urls or other useless stuff). Only lines
239that are being shown will be filtered, and, due to performance reasons, 285that are being shown will be filtered, and, due to performance reasons,
261 307
262Called whenever the user presses a key combination that has a 308Called whenever the user presses a key combination that has a
263C<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>
264resource in the @@RXVT_NAME@@(1) manpage). 310resource in the @@RXVT_NAME@@(1) manpage).
265 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
266=item on_key_press $term, $event, $octets 322=item on_key_press $term, $event, $keysym, $octets
267 323
268=item on_key_release $term, $event 324=item on_key_release $term, $event, $keysym
269 325
270=item on_button_press $term, $event 326=item on_button_press $term, $event
271 327
272=item on_button_release $term, $event 328=item on_button_release $term, $event
273 329
274=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
275 335
276Called whenever the corresponding X event is received for the terminal If 336Called whenever the corresponding X event is received for the terminal If
277the 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.
278 338
279The 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
285 345
286subwindow. 346subwindow.
287 347
288=back 348=back
289 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
290=head2 Variables in the C<urxvt> Package 371=head2 Variables in the C<urxvt> Package
291 372
292=over 4 373=over 4
293 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>.
387
294=item $urxvt::TERM 388=item $urxvt::TERM
295 389
296The current terminal. Whenever a callback/Hook is bein executed, this 390The current terminal. This variable stores the current C<urxvt::term>
297variable stores the current C<urxvt::term> object. 391object, whenever a callback/hook is executing.
298 392
299=back 393=back
300 394
301=head2 Functions in the C<urxvt> Package 395=head2 Functions in the C<urxvt> Package
302 396
303=over 4 397=over 4
304
305=item $term = new urxvt [arg...]
306
307Creates a new terminal, very similar as if you had started it with
308C<system $binfile, arg...>. Croaks (and probably outputs an error message)
309if the new instance couldn't be created. Returns C<undef> if the new
310instance didn't initialise perl, and the terminal object otherwise. The
311C<init> and C<start> hooks will be called during the call.
312 398
313=item urxvt::fatal $errormessage 399=item urxvt::fatal $errormessage
314 400
315Fatally aborts execution with the given error message. Avoid at all 401Fatally aborts execution with the given error message. Avoid at all
316costs! The only time this is acceptable is when the terminal process 402costs! The only time this is acceptable is when the terminal process
323that calls this function. 409that calls this function.
324 410
325Using 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
326correct place, e.g. on stderr of the connecting urxvtc client. 412correct place, e.g. on stderr of the connecting urxvtc client.
327 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
328=item $time = urxvt::NOW 422=item $time = urxvt::NOW
329 423
330Returns 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.
331 433
332=back 434=back
333 435
334=head2 RENDITION 436=head2 RENDITION
335 437
362 464
363=item $background = urxvt::GET_BASEBG $rend 465=item $background = urxvt::GET_BASEBG $rend
364 466
365Return the foreground/background colour index, respectively. 467Return the foreground/background colour index, respectively.
366 468
367=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) 469=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
368 470
369=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) 471=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
370 472
371Replace the foreground/background colour in the rendition mask with the 473Replace the foreground/background colour in the rendition mask with the
372specified one. 474specified one.
373 475
374=item $value = urxvt::GET_CUSTOM ($rend) 476=item $value = urxvt::GET_CUSTOM $rend
375 477
376Return the "custom" value: Every rendition has 5 bits for use by 478Return the "custom" value: Every rendition has 5 bits for use by
377extensions. 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
378zero. 480zero.
379 481
380=item $rend = urxvt::SET_CUSTOM ($rend, $new_value) 482=item $rend = urxvt::SET_CUSTOM $rend, $new_value
381 483
382Change the custom value. 484Change the custom value.
383 485
384=back 486=back
385 487
386=cut 488=cut
387
388package urxvt;
389
390use strict;
391use Scalar::Util ();
392
393our $TERM;
394our @HOOKNAME;
395our $LIBDIR;
396 489
397BEGIN { 490BEGIN {
398 urxvt->bootstrap; 491 urxvt->bootstrap;
399 492
400 # overwrite perl's warn 493 # overwrite perl's warn
402 my $msg = join "", @_; 495 my $msg = join "", @_;
403 $msg .= "\n" 496 $msg .= "\n"
404 unless $msg =~ /\n$/; 497 unless $msg =~ /\n$/;
405 urxvt::warn ($msg); 498 urxvt::warn ($msg);
406 }; 499 };
500
501 delete $ENV{IFS};
502 delete $ENV{CDPATH};
503 delete $ENV{BASH_ENV};
504 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
407} 505}
408 506
409my @hook_count; 507my @hook_count;
410my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 508my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
411 509
412sub verbose { 510sub verbose {
413 my ($level, $msg) = @_; 511 my ($level, $msg) = @_;
414 warn "$msg\n" if $level <= $verbosity; 512 warn "$msg\n" if $level <= $verbosity;
415} 513}
416 514
417# find on_xxx subs in the package and register them 515my $extension_pkg = "extension0000";
418# as hooks 516my %extension_pkg;
419sub register_package($) {
420 my ($pkg) = @_;
421
422 for my $htype (0.. $#HOOKNAME) {
423 my $name = $HOOKNAME[$htype];
424
425 my $ref = $pkg->can ("on_" . lc $name)
426 or next;
427
428 $TERM->{_hook}[$htype]{$pkg} = $ref;
429 $hook_count[$htype]++
430 or set_should_invoke $htype, 1;
431 }
432}
433
434my $script_pkg = "script0000";
435my %script_pkg;
436 517
437# load a single script into its own package, once only 518# load a single script into its own package, once only
438sub script_package($) { 519sub extension_package($) {
439 my ($path) = @_; 520 my ($path) = @_;
440 521
441 $script_pkg{$path} ||= do { 522 $extension_pkg{$path} ||= do {
442 my $pkg = "urxvt::" . ($script_pkg++); 523 my $pkg = "urxvt::" . ($extension_pkg++);
443 524
444 verbose 3, "loading script '$path' into package '$pkg'"; 525 verbose 3, "loading extension '$path' into package '$pkg'";
445 526
446 open my $fh, "<:raw", $path 527 open my $fh, "<:raw", $path
447 or die "$path: $!"; 528 or die "$path: $!";
448 529
530 my $source = untaint
449 my $source = "package $pkg; use strict; use utf8;\n" 531 "package $pkg; use strict; use utf8;\n"
532 . "use base urxvt::term::extension::;\n"
450 . "#line 1 \"$path\"\n{\n" 533 . "#line 1 \"$path\"\n{\n"
451 . (do { local $/; <$fh> }) 534 . (do { local $/; <$fh> })
452 . "\n};\n1"; 535 . "\n};\n1";
453 536
537 eval $source
454 eval $source or die "$path: $@"; 538 or die "$path: $@";
455 539
456 $pkg 540 $pkg
457 } 541 }
458} 542}
459 543
464 local $TERM = shift; 548 local $TERM = shift;
465 my $htype = shift; 549 my $htype = shift;
466 550
467 if ($htype == 0) { # INIT 551 if ($htype == 0) { # INIT
468 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 552 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
553
554 my %ext_arg;
469 555
470 for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 556 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
557 if ($_ eq "default") {
558 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
559 } elsif (/^-(.*)$/) {
560 delete $ext_arg{$1};
561 } elsif (/^([^<]+)<(.*)>$/) {
562 push @{ $ext_arg{$1} }, $2;
563 } else {
564 $ext_arg{$_} ||= [];
565 }
566 }
567
568 while (my ($ext, $argv) = each %ext_arg) {
471 my @files = grep -f $_, map "$_/$ext", @dirs; 569 my @files = grep -f $_, map "$_/$ext", @dirs;
472 570
473 if (@files) { 571 if (@files) {
474 register_package script_package $files[0]; 572 $TERM->register_package (extension_package $files[0], $argv);
475 } else { 573 } else {
476 warn "perl extension '$ext' not found in perl library search path\n"; 574 warn "perl extension '$ext' not found in perl library search path\n";
477 } 575 }
478 } 576 }
577
578 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
579 warn $@ if $@;
479 } 580 }
480 581
481 $retval = undef; 582 $retval = undef;
482 583
483 if (my $cb = $TERM->{_hook}[$htype]) { 584 if (my $cb = $TERM->{_hook}[$htype]) {
485 if $verbosity >= 10; 586 if $verbosity >= 10;
486 587
487 keys %$cb; 588 keys %$cb;
488 589
489 while (my ($pkg, $cb) = each %$cb) { 590 while (my ($pkg, $cb) = each %$cb) {
490 $retval = $cb->( 591 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
491 $TERM->{_pkg}{$pkg} ||= do {
492 my $proxy = bless { }, urxvt::term::proxy::;
493 Scalar::Util::weaken ($proxy->{term} = $TERM);
494 $proxy
495 },
496 @_,
497 ) and last; 592 and last;
593
594 if ($@) {
595 $TERM->ungrab; # better to lose the grab than the session
596 warn $@;
597 }
498 } 598 }
499 } 599 }
500 600
501 if ($htype == 1) { # DESTROY 601 if ($htype == 1) { # DESTROY
502 # remove hooks if unused
503 if (my $hook = $TERM->{_hook}) { 602 if (my $hook = delete $TERM->{_hook}) {
504 for my $htype (0..$#$hook) { 603 for my $htype (0..$#$hook) {
505 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } 604 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
506 or set_should_invoke $htype, 0; 605 or set_should_invoke $htype, 0;
507 } 606 }
508 } 607 }
515 } 614 }
516 615
517 $retval 616 $retval
518} 617}
519 618
520sub urxvt::term::proxy::AUTOLOAD { 619# urxvt::term::extension
521 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 620
621package urxvt::term::extension;
622
623sub enable {
624 my ($self, %hook) = @_;
625 my $pkg = $self->{_pkg};
626
627 while (my ($name, $cb) = each %hook) {
628 my $htype = $HOOKTYPE{uc $name};
629 defined $htype
630 or Carp::croak "unsupported hook type '$name'";
631
632 unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
633 $hook_count[$htype]++
634 or urxvt::set_should_invoke $htype, 1;
635 }
636
637 $self->{term}{_hook}[$htype]{$pkg} = $cb;
638 }
639}
640
641sub disable {
642 my ($self, @hook) = @_;
643 my $pkg = $self->{_pkg};
644
645 for my $name (@hook) {
646 my $htype = $HOOKTYPE{uc $name};
647 defined $htype
648 or Carp::croak "unsupported hook type '$name'";
649
650 if (delete $self->{term}{_hook}[$htype]{$pkg}) {
651 --$hook_count[$htype]
652 or urxvt::set_should_invoke $htype, 0;
653 }
654 }
655}
656
657our $AUTOLOAD;
658
659sub AUTOLOAD {
660 $AUTOLOAD =~ /:([^:]+)$/
522 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 661 or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
523 662
524 eval qq{ 663 eval qq{
525 sub $urxvt::term::proxy::AUTOLOAD { 664 sub $AUTOLOAD {
526 my \$proxy = shift; 665 my \$proxy = shift;
527 \$proxy->{term}->$1 (\@_) 666 \$proxy->{term}->$1 (\@_)
528 } 667 }
529 1 668 1
530 } or die "FATAL: unable to compile method forwarder: $@"; 669 } or die "FATAL: unable to compile method forwarder: $@";
531 670
532 goto &$urxvt::term::proxy::AUTOLOAD; 671 goto &$AUTOLOAD;
533} 672}
673
674sub DESTROY {
675 # nop
676}
677
678# urxvt::destroy_hook
679
680sub urxvt::destroy_hook::DESTROY {
681 ${$_[0]}->();
682}
683
684sub urxvt::destroy_hook(&) {
685 bless \shift, urxvt::destroy_hook::
686}
687
688package urxvt::anyevent;
689
690=head2 The C<urxvt::anyevent> Class
691
692The sole purpose of this class is to deliver an interface to the
693C<AnyEvent> module - any module using it will work inside urxvt without
694further programming. The only exception is that you cannot wait on
695condition variables, but non-blocking condvar use is ok. What this means
696is that you cannot use blocking APIs, but the non-blocking variant should
697work.
698
699=cut
700
701our $VERSION = 1;
702
703$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
704push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
705
706sub timer {
707 my ($class, %arg) = @_;
708
709 my $cb = $arg{cb};
710
711 urxvt::timer
712 ->new
713 ->start (urxvt::NOW + $arg{after})
714 ->cb (sub {
715 $_[0]->stop; # need to cancel manually
716 $cb->();
717 })
718}
719
720sub io {
721 my ($class, %arg) = @_;
722
723 my $cb = $arg{cb};
724
725 bless [$arg{fh}, urxvt::iow
726 ->new
727 ->fd (fileno $arg{fh})
728 ->events (($arg{poll} =~ /r/ ? 1 : 0)
729 | ($arg{poll} =~ /w/ ? 2 : 0))
730 ->start
731 ->cb (sub {
732 $cb->(($_[1] & 1 ? 'r' : '')
733 . ($_[1] & 2 ? 'w' : ''));
734 })],
735 urxvt::anyevent::
736}
737
738sub DESTROY {
739 $_[0][1]->stop;
740}
741
742sub condvar {
743 bless \my $flag, urxvt::anyevent::condvar::
744}
745
746sub urxvt::anyevent::condvar::broadcast {
747 ${$_[0]}++;
748}
749
750sub urxvt::anyevent::condvar::wait {
751 unless (${$_[0]}) {
752 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
753 }
754}
755
756package urxvt::term;
534 757
535=head2 The C<urxvt::term> Class 758=head2 The C<urxvt::term> Class
536 759
537=over 4 760=over 4
538 761
762=cut
763
764# find on_xxx subs in the package and register them
765# as hooks
766sub register_package {
767 my ($self, $pkg, $argv) = @_;
768
769 my $proxy = bless {
770 _pkg => $pkg,
771 argv => $argv,
772 }, $pkg;
773 Scalar::Util::weaken ($proxy->{term} = $self);
774
775 $self->{_pkg}{$pkg} = $proxy;
776
777 for my $name (@HOOKNAME) {
778 if (my $ref = $pkg->can ("on_" . lc $name)) {
779 $proxy->enable ($name => $ref);
780 }
781 }
782}
783
784=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
785
786Creates a new terminal, very similar as if you had started it with system
787C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
788hash which defines the environment of the new terminal.
789
790Croaks (and probably outputs an error message) if the new instance
791couldn't be created. Returns C<undef> if the new instance didn't
792initialise perl, and the terminal object otherwise. The C<init> and
793C<start> hooks will be called during this call.
794
795=cut
796
797sub new {
798 my ($class, $env, @args) = @_;
799
800 _new ([ map "$_=$env->{$_}", keys %$env ], @args);
801}
802
539=item $term->destroy 803=item $term->destroy
540 804
541Destroy the terminal object (close the window, free resources etc.). 805Destroy the terminal object (close the window, free resources
806etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
807watchers (timers, io watchers) are still active.
808
809=item $isset = $term->option ($optval[, $set])
810
811Returns true if the option specified by C<$optval> is enabled, and
812optionally change it. All option values are stored by name in the hash
813C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
814
815Here is a a likely non-exhaustive list of option names, please see the
816source file F</src/optinc.h> to see the actual list:
817
818 borderLess console cursorBlink cursorUnderline hold iconic insecure
819 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
820 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
821 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
822 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
823 tripleclickwords utmpInhibit visualBell
542 824
543=item $value = $term->resource ($name[, $newval]) 825=item $value = $term->resource ($name[, $newval])
544 826
545Returns the current resource value associated with a given name and 827Returns the current resource value associated with a given name and
546optionally sets a new value. Setting values is most useful in the C<init> 828optionally sets a new value. Setting values is most useful in the C<init>
556 838
557Please note that resource strings will currently only be freed when the 839Please note that resource strings will currently only be freed when the
558terminal is destroyed, so changing options frequently will eat memory. 840terminal is destroyed, so changing options frequently will eat memory.
559 841
560Here is a a likely non-exhaustive list of resource names, not all of which 842Here is a a likely non-exhaustive list of resource names, not all of which
561are supported in every build, please see the source to see the actual 843are supported in every build, please see the source file F</src/rsinc.h>
562list: 844to see the actual list:
563 845
564 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 846 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
565 borderLess color cursorBlink cursorUnderline cutchars delete_key 847 borderLess color cursorBlink cursorUnderline cutchars delete_key
566 display_name embed ext_bwidth fade font geometry hold iconName 848 display_name embed ext_bwidth fade font geometry hold iconName
567 imFont imLocale inputMethod insecure int_bwidth intensityStyles 849 imFont imLocale inputMethod insecure int_bwidth intensityStyles
574 shade term_name title transparent transparent_all tripleclickwords 856 shade term_name title transparent transparent_all tripleclickwords
575 utmpInhibit visualBell 857 utmpInhibit visualBell
576 858
577=cut 859=cut
578 860
579sub urxvt::term::resource($$;$) { 861sub resource($$;$) {
580 my ($self, $name) = (shift, shift); 862 my ($self, $name) = (shift, shift);
581 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 863 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
582 goto &urxvt::term::_resource; 864 &urxvt::term::_resource
583} 865}
866
867=item $value = $term->x_resource ($pattern)
868
869Returns the X-Resource for the given pattern, excluding the program or
870class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
871same value as used by this instance of rxvt-unicode. Returns C<undef> if no
872resource with that pattern exists.
873
874This method should only be called during the C<on_start> hook, as there is
875only one resource database per display, and later invocations might return
876the wrong resources.
877
878=item $success = $term->parse_keysym ($keysym_spec, $command_string)
879
880Adds a keymap translation exactly as specified via a resource. See the
881C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
584 882
585=item $rend = $term->rstyle ([$new_rstyle]) 883=item $rend = $term->rstyle ([$new_rstyle])
586 884
587Return and optionally change the current rendition. Text that is output by 885Return and optionally change the current rendition. Text that is output by
588the terminal application will use this style. 886the terminal application will use this style.
608 906
609=item $oldtext = $term->selection ([$newtext]) 907=item $oldtext = $term->selection ([$newtext])
610 908
611Return the current selection text and optionally replace it by C<$newtext>. 909Return the current selection text and optionally replace it by C<$newtext>.
612 910
613#=item $term->overlay ($x, $y, $text) 911=item $term->overlay_simple ($x, $y, $text)
614# 912
615#Create a simple multi-line overlay box. See the next method for details. 913Create a simple multi-line overlay box. See the next method for details.
616# 914
617#=cut 915=cut
618# 916
619#sub urxvt::term::scr_overlay { 917sub overlay_simple {
620# my ($self, $x, $y, $text) = @_; 918 my ($self, $x, $y, $text) = @_;
621# 919
622# my @lines = split /\n/, $text; 920 my @lines = split /\n/, $text;
623# 921
624# my $w = 0; 922 my $w = List::Util::max map $self->strwidth ($_), @lines;
625# for (map $self->strwidth ($_), @lines) { 923
626# $w = $_ if $w < $_;
627# }
628#
629# $self->scr_overlay_new ($x, $y, $w, scalar @lines); 924 my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
630# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; 925 $overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
631#} 926
927 $overlay
928}
632 929
633=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) 930=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
634 931
635Create a new (empty) overlay at the given position with the given 932Create a new (empty) overlay at the given position with the given
636width/height. C<$rstyle> defines the initial rendition style 933width/height. C<$rstyle> defines the initial rendition style
663 960
664If hidden, display the overlay again. 961If hidden, display the overlay again.
665 962
666=back 963=back
667 964
965=item $popup = $term->popup ($event)
966
967Creates a new C<urxvt::popup> object that implements a popup menu. The
968C<$event> I<must> be the event causing the menu to pop up (a button event,
969currently).
970
971=cut
972
973sub popup {
974 my ($self, $event) = @_;
975
976 $self->grab ($event->{time}, 1)
977 or return;
978
979 my $popup = bless {
980 term => $self,
981 event => $event,
982 }, urxvt::popup::;
983
984 Scalar::Util::weaken $popup->{term};
985
986 $self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
987 Scalar::Util::weaken $self->{_destroy}{$popup};
988
989 $popup
990}
991
668=item $cellwidth = $term->strwidth ($string) 992=item $cellwidth = $term->strwidth ($string)
669 993
670Returns the number of screen-cells this string would need. Correctly 994Returns the number of screen-cells this string would need. Correctly
671accounts for wide and combining characters. 995accounts for wide and combining characters.
672 996
675Convert the given text string into the corresponding locale encoding. 999Convert the given text string into the corresponding locale encoding.
676 1000
677=item $string = $term->locale_decode ($octets) 1001=item $string = $term->locale_decode ($octets)
678 1002
679Convert the given locale-encoded octets into a perl string. 1003Convert the given locale-encoded octets into a perl string.
1004
1005=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1006
1007XORs the rendition values in the given span with the provided value
1008(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
1009to the selection.
1010
1011=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1012
1013Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1014whitespace will additionally be xored with the C<$rstyle2>, which defaults
1015to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1016it instead.
1017
1018=item $term->scr_bell
1019
1020Ring the bell!
680 1021
681=item $term->scr_add_lines ($string) 1022=item $term->scr_add_lines ($string)
682 1023
683Write the given text string to the screen, as if output by the application 1024Write the given text string to the screen, as if output by the application
684running inside the terminal. It may not contain command sequences (escape 1025running inside the terminal. It may not contain command sequences (escape
699 1040
700Write the octets given in C<$data> to the tty (i.e. as program input). To 1041Write the octets given in C<$data> to the tty (i.e. as program input). To
701pass characters instead of octets, you should convert your strings first 1042pass characters instead of octets, you should convert your strings first
702to the locale-specific encoding using C<< $term->locale_encode >>. 1043to the locale-specific encoding using C<< $term->locale_encode >>.
703 1044
1045=item $old_events = $term->pty_ev_events ([$new_events])
1046
1047Replaces the event mask of the pty watcher by the given event mask. Can
1048be used to suppress input and output handling to the pty/tty. See the
1049description of C<< urxvt::timer->events >>. Make sure to always restore
1050the previous value.
1051
704=item $windowid = $term->parent 1052=item $windowid = $term->parent
705 1053
706Return the window id of the toplevel window. 1054Return the window id of the toplevel window.
707 1055
708=item $windowid = $term->vt 1056=item $windowid = $term->vt
732=item $nrow_plus_saveLines = $term->total_rows 1080=item $nrow_plus_saveLines = $term->total_rows
733 1081
734=item $lines_in_scrollback = $term->nsaved 1082=item $lines_in_scrollback = $term->nsaved
735 1083
736Return various integers describing terminal characteristics. 1084Return various integers describing terminal characteristics.
1085
1086=item $x_display = $term->display_id
1087
1088Return the DISPLAY used by rxvt-unicode.
1089
1090=item $lc_ctype = $term->locale
1091
1092Returns the LC_CTYPE category string used by this rxvt-unicode.
1093
1094=item $env = $term->env
1095
1096Returns a copy of the environment in effect for the terminal as a hashref
1097similar to C<\%ENV>.
1098
1099=cut
1100
1101sub env {
1102 if (my $env = $_[0]->_env) {
1103 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
1104 } else {
1105 +{ %ENV }
1106 }
1107}
1108
1109=item $modifiermask = $term->ModLevel3Mask
1110
1111=item $modifiermask = $term->ModMetaMask
1112
1113=item $modifiermask = $term->ModNumLockMask
1114
1115Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1116AltGr), the meta key (often Alt) and the num lock key, if applicable.
737 1117
738=item $view_start = $term->view_start ([$newvalue]) 1118=item $view_start = $term->view_start ([$newvalue])
739 1119
740Returns the negative row number of the topmost line. Minimum value is 1120Returns the negative row number of the topmost line. Minimum value is
741C<0>, which displays the normal terminal contents. Larger values scroll 1121C<0>, which displays the normal terminal contents. Larger values scroll
835 1215
836=back 1216=back
837 1217
838=cut 1218=cut
839 1219
840sub urxvt::term::line { 1220sub line {
841 my ($self, $row) = @_; 1221 my ($self, $row) = @_;
842 1222
843 my $maxrow = $self->nrow - 1; 1223 my $maxrow = $self->nrow - 1;
844 1224
845 my ($beg, $end) = ($row, $row); 1225 my ($beg, $end) = ($row, $row);
909 $offset / $self->{ncol} + $self->{beg}, 1289 $offset / $self->{ncol} + $self->{beg},
910 $offset % $self->{ncol} 1290 $offset % $self->{ncol}
911 ) 1291 )
912} 1292}
913 1293
914=item ($row, $col) = $line->coord_of ($offset)
915=item $text = $term->special_encode $string 1294=item $text = $term->special_encode $string
916 1295
917Converts a perl string into the special encoding used by rxvt-unicode, 1296Converts a perl string into the special encoding used by rxvt-unicode,
918where one character corresponds to one screen cell. See 1297where one character corresponds to one screen cell. See
919C<< $term->ROW_t >> for details. 1298C<< $term->ROW_t >> for details.
920 1299
921=item $string = $term->special_decode $text 1300=item $string = $term->special_decode $text
922 1301
923Converts rxvt-unicodes text reprsentation into a perl string. See 1302Converts rxvt-unicodes text reprsentation into a perl string. See
924C<< $term->ROW_t >> for details. 1303C<< $term->ROW_t >> for details.
1304
1305=item $success = $term->grab_button ($button, $modifiermask)
1306
1307Registers a synchronous button grab. See the XGrabButton manpage.
1308
1309=item $success = $term->grab ($eventtime[, $sync])
1310
1311Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1312synchronous (C<$sync> is true). Also remembers the grab timestampe.
1313
1314=item $term->allow_events_async
1315
1316Calls XAllowEvents with AsyncBoth for the most recent grab.
1317
1318=item $term->allow_events_sync
1319
1320Calls XAllowEvents with SyncBoth for the most recent grab.
1321
1322=item $term->allow_events_replay
1323
1324Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1325recent grab.
1326
1327=item $term->ungrab
1328
1329Calls XUngrab for the most recent grab. Is called automatically on
1330evaluation errors, as it is better to lose the grab in the error case as
1331the session.
1332
1333=back
1334
1335=cut
1336
1337package urxvt::popup;
1338
1339=head2 The C<urxvt::popup> Class
1340
1341=over 4
1342
1343=cut
1344
1345sub add_item {
1346 my ($self, $item) = @_;
1347
1348 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
1349 $item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
1350 $item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
1351
1352 $item->{render} ||= sub { $_[0]{text} };
1353
1354 push @{ $self->{item} }, $item;
1355}
1356
1357=item $popup->add_title ($title)
1358
1359Adds a non-clickable title to the popup.
1360
1361=cut
1362
1363sub add_title {
1364 my ($self, $title) = @_;
1365
1366 $self->add_item ({
1367 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
1368 text => $title,
1369 activate => sub { },
1370 });
1371}
1372
1373=item $popup->add_separator ([$sepchr])
1374
1375Creates a separator, optionally using the character given as C<$sepchr>.
1376
1377=cut
1378
1379sub add_separator {
1380 my ($self, $sep) = @_;
1381
1382 $sep ||= "=";
1383
1384 $self->add_item ({
1385 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1386 text => "",
1387 render => sub { $sep x $self->{term}->ncol },
1388 activate => sub { },
1389 });
1390}
1391
1392=item $popup->add_button ($text, $cb)
1393
1394Adds a clickable button to the popup. C<$cb> is called whenever it is
1395selected.
1396
1397=cut
1398
1399sub add_button {
1400 my ($self, $text, $cb) = @_;
1401
1402 $self->add_item ({ type => "button", text => $text, activate => $cb});
1403}
1404
1405=item $popup->add_toggle ($text, $cb, $initial_value)
1406
1407Adds a toggle/checkbox item to the popup. Teh callback gets called
1408whenever it gets toggled, with a boolean indicating its value as its first
1409argument.
1410
1411=cut
1412
1413sub add_toggle {
1414 my ($self, $text, $cb, $value) = @_;
1415
1416 my $item; $item = {
1417 type => "button",
1418 text => " $text",
1419 value => $value,
1420 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1421 activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1422 };
1423
1424 $self->add_item ($item);
1425}
1426
1427=item $popup->show
1428
1429Displays the popup (which is initially hidden).
1430
1431=cut
1432
1433sub show {
1434 my ($self) = @_;
1435
1436 local $urxvt::popup::self = $self;
1437
1438 my $env = $self->{term}->env;
1439 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1440 delete $env->{LC_ALL};
1441 $env->{LC_CTYPE} = $self->{term}->locale;
1442
1443 urxvt::term->new ($env, $self->{term}->resource ("name"),
1444 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1445 "--transient-for" => $self->{term}->parent,
1446 "-display" => $self->{term}->display_id,
1447 "-pe" => "urxvt-popup")
1448 or die "unable to create popup window\n";
1449}
1450
1451sub DESTROY {
1452 my ($self) = @_;
1453
1454 delete $self->{term}{_destroy}{$self};
1455 $self->{term}->ungrab;
1456}
925 1457
926=back 1458=back
927 1459
928=head2 The C<urxvt::timer> Class 1460=head2 The C<urxvt::timer> Class
929 1461
984 1516
985 $term->{socket} = ... 1517 $term->{socket} = ...
986 $term->{iow} = urxvt::iow 1518 $term->{iow} = urxvt::iow
987 ->new 1519 ->new
988 ->fd (fileno $term->{socket}) 1520 ->fd (fileno $term->{socket})
989 ->events (1) # wait for read data 1521 ->events (urxvt::EVENT_READ)
990 ->start 1522 ->start
991 ->cb (sub { 1523 ->cb (sub {
992 my ($iow, $revents) = @_; 1524 my ($iow, $revents) = @_;
993 # $revents must be 1 here, no need to check 1525 # $revents must be 1 here, no need to check
994 sysread $term->{socket}, my $buf, 8192 1526 sysread $term->{socket}, my $buf, 8192
1011 1543
1012Set the filedescriptor (not handle) to watch. 1544Set the filedescriptor (not handle) to watch.
1013 1545
1014=item $iow = $iow->events ($eventmask) 1546=item $iow = $iow->events ($eventmask)
1015 1547
1016Set the event mask to watch. Bit #0 (value C<1>) enables watching for read 1548Set the event mask to watch. The only allowed values are
1017data, Bit #1 (value C<2>) enables watching for write data. 1549C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
1550together, or C<urxvt::EVENT_NONE>.
1018 1551
1019=item $iow = $iow->start 1552=item $iow = $iow->start
1020 1553
1021Start watching for requested events on the given handle. 1554Start watching for requested events on the given handle.
1022 1555
1033This variable controls the verbosity level of the perl extension. Higher 1566This variable controls the verbosity level of the perl extension. Higher
1034numbers indicate more verbose output. 1567numbers indicate more verbose output.
1035 1568
1036=over 4 1569=over 4
1037 1570
1038=item =0 - only fatal messages 1571=item == 0 - fatal messages
1039 1572
1040=item =3 - script loading and management 1573=item >= 3 - script loading and management
1041 1574
1042=item =10 - all events received 1575=item >=10 - all events received
1043 1576
1044=back 1577=back
1045 1578
1046=head1 AUTHOR 1579=head1 AUTHOR
1047 1580

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines