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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines