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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines