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.61 by root, Mon Jan 9 01:36:56 2006 UTC vs.
Revision 1.93 by root, Fri Jan 13 07:03:48 2006 UTC

26thus must be encoded as UTF-8. 26thus must be encoded as UTF-8.
27 27
28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where 28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29scripts will be shared (but not enabled) for all terminals. 29scripts will be shared (but not enabled) for all terminals.
30 30
31=head2 Prepackaged Extensions 31=head1 PREPACKAGED EXTENSIONS
32 32
33This section describes the extensiosn delivered with this version. You can 33This section describes the extensions delivered with this release. You can
34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35 35
36You can activate them like this: 36You can activate them like this:
37 37
38 @@RXVT_NAME@@ -pe <extensionname> 38 @@RXVT_NAME@@ -pe <extensionname>
39 39
40=over 4 40=over 4
41 41
42=item selection (enabled by default) 42=item selection (enabled by default)
43 43
44Intelligent selection. This extension tries to be more intelligent when 44(More) intelligent selection. This extension tries to be more intelligent
45the user extends selections (double-click). Right now, it tries to select 45when the user extends selections (double-click and further clicks). Right
46urls and complete shell-quoted arguments, which is very convenient, too, 46now, it tries to select words, urls and complete shell-quoted
47if your F<ls> supports C<--quoting-style=shell>. 47arguments, which is very convenient, too, if your F<ls> supports
48C<--quoting-style=shell>.
48 49
49It also offers the following bindable event: 50A double-click usually selects the word under the cursor, further clicks
51will enlarge the selection.
52
53The selection works by trying to match a number of regexes and displaying
54them in increasing order of length. You can add your own regexes by
55specifying resources of the form:
56
57 URxvt.selection.pattern-0: perl-regex
58 URxvt.selection.pattern-1: perl-regex
59 ...
60
61The index number (0, 1...) must not have any holes, and each regex must
62contain at least one pair of capturing parentheses, which will be used for
63the match. For example, the followign adds a regex that matches everything
64between two vertical bars:
65
66 URxvt.selection.pattern-0: \\|([^|]+)\\|
67
68You can look at the source of the selection extension to see more
69interesting uses, such as parsing a line from beginning to end.
70
71This extension also offers the following bindable keyboard command:
50 72
51=over 4 73=over 4
52 74
53=item rot13 75=item rot13
54 76
64runtime. 86runtime.
65 87
66=item selection-popup (enabled by default) 88=item selection-popup (enabled by default)
67 89
68Binds a popup menu to Ctrl-Button3 that lets you convert the selection 90Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69text into various other formats/action. 91text into various other formats/action (such as uri unescaping, perl
92evalution, web-browser starting etc.), depending on content.
70 93
71=item digital-clock 94=item searchable-scrollback<hotkey> (enabled by default)
72 95
73Displays a digital clock using the built-in overlay. 96Adds regex search functionality to the scrollback buffer, triggered
97by a hotkey (default: C<M-s>). While in search mode, normal terminal
98input/output is suspended and a regex is displayed at the bottom of the
99screen.
100
101Inputting characters appends them to the regex and continues incremental
102search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
103search upwards/downwards in the scrollback buffer, C<End> jumps to the
104bottom. C<Escape> leaves search mode and returns to the point where search
105was started, while C<Enter> or C<Return> stay at the current position and
106additionally stores the first match in the current line into the primary
107selection.
108
109=item selection-autotransform
110
111This selection allows you to do automatic transforms on a selection
112whenever a selection is made.
113
114It works by specifying perl snippets (most useful is a single C<s///>
115operator) that modify C<$_> as resources:
116
117 URxvt.selection-autotransform.0: transform
118 URxvt.selection-autotransform.1: transform
119 ...
120
121For example, the following will transform selections of the form
122C<filename:number>, often seen in compiler messages, into C<vi +$filename
123$word>:
124
125 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126
127And this example matches the same,but replaces it with vi-commands you can
128paste directly into your (vi :) editor:
129
130 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
131
132Of course, this can be modified to suit your needs and your editor :)
133
134To expand the example above to typical perl error messages ("XXX at
135FILENAME line YYY."), you need a slightly more elaborate solution:
136
137 URxvt.selection.pattern-0: ( at .*? line \\d+\\.)
138 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/
139
140The first line tells the selection code to treat the unchanging part of
141every error message as a selection pattern, and the second line transforms
142the message into vi commands to load the file.
74 143
75=item mark-urls 144=item mark-urls
76 145
77Uses per-line display filtering (C<on_line_update>) to underline urls. 146Uses per-line display filtering (C<on_line_update>) to underline urls and
147make them clickable. When middle-clicked, the program specified in the
148resource C<urlLauncher> (default C<x-www-browser>) will be started with
149the URL as first argument.
78 150
79=item block-graphics-to-ascii 151=item block-graphics-to-ascii
80 152
81A not very useful example of filtering all text output to the terminal, 153A not very useful example of filtering all text output to the terminal,
82by replacing all line-drawing characters (U+2500 .. U+259F) by a 154by replacing all line-drawing characters (U+2500 .. U+259F) by a
83similar-looking ascii character. 155similar-looking ascii character.
84 156
157=item digital-clock
158
159Displays a digital clock using the built-in overlay.
160
85=item example-refresh-hooks 161=item example-refresh-hooks
86 162
87Displays a very simple digital clock in the upper right corner of the 163Displays a very simple digital clock in the upper right corner of the
88window. Illustrates overwriting the refresh callbacks to create your own 164window. Illustrates overwriting the refresh callbacks to create your own
89overlays or changes. 165overlays or changes.
90 166
91=back 167=back
168
169=head1 API DOCUMENTATION
92 170
93=head2 General API Considerations 171=head2 General API Considerations
94 172
95All objects (such as terminals, time watchers etc.) are typical 173All objects (such as terminals, time watchers etc.) are typical
96reference-to-hash objects. The hash can be used to store anything you 174reference-to-hash objects. The hash can be used to store anything you
109=over 4 187=over 4
110 188
111=item $text 189=item $text
112 190
113Rxvt-unicodes special way of encoding text, where one "unicode" character 191Rxvt-unicodes special way of encoding text, where one "unicode" character
114always represents one screen cell. See L<row_t> for a discussion of this format. 192always represents one screen cell. See L<ROW_t> for a discussion of this format.
115 193
116=item $string 194=item $string
117 195
118A perl text string, with an emphasis on I<text>. It can store all unicode 196A perl text string, with an emphasis on I<text>. It can store all unicode
119characters and is to be distinguished with text encoded in a specific 197characters and is to be distinguished with text encoded in a specific
124Either binary data or - more common - a text string encoded in a 202Either binary data or - more common - a text string encoded in a
125locale-specific way. 203locale-specific way.
126 204
127=back 205=back
128 206
207=head2 Extension Objects
208
209Very perl extension is a perl class. A separate perl object is created
210for each terminal and each extension and passed as the first parameter to
211hooks. So extensions can use their C<$self> object without having to think
212about other extensions, with the exception of methods and members that
213begin with an underscore character C<_>: these are reserved for internal
214use.
215
216Although it isn't a C<urxvt::term> object, you can call all methods of the
217C<urxvt::term> class on this object.
218
219It has the following methods and data members:
220
221=over 4
222
223=item $urxvt_term = $self->{term}
224
225Returns the C<urxvt::term> object associated with this instance of the
226extension. This member I<must not> be changed in any way.
227
228=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
229
230Dynamically enable the given hooks (named without the C<on_> prefix) for
231this extension, replacing any previous hook. This is useful when you want
232to overwrite time-critical hooks only temporarily.
233
234=item $self->disable ($hook_name[, $hook_name..])
235
236Dynamically disable the given hooks.
237
238=back
239
129=head2 Hooks 240=head2 Hooks
130 241
131The following subroutines can be declared in extension files, and will be 242The following subroutines can be declared in extension files, and will be
132called whenever the relevant event happens. 243called whenever the relevant event happens.
133 244
134The first argument passed to them is an object private to each terminal 245The first argument passed to them is an extension oject as described in
135and extension package. You can call all C<urxvt::term> methods on it, but 246the in the C<Extension Objects> section.
136its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
137object that is shared between all packages is stored in the C<term>
138member. It is, however, blessed intot he package of the extension script,
139so for all practical purposes you can treat an extension script as a class.
140 247
141All of them must return a boolean value. If it is true, then the event 248B<All> of these hooks must return a boolean value. If it is true, then the
142counts as being I<consumed>, and the invocation of other hooks is skipped, 249event counts as being I<consumed>, and the invocation of other hooks is
143and the relevant action might not be carried out by the C++ code. 250skipped, and the relevant action might not be carried out by the C++ code.
144 251
145When in doubt, return a false value (preferably C<()>). 252I<< When in doubt, return a false value (preferably C<()>). >>
146 253
147=over 4 254=over 4
148 255
149=item on_init $term 256=item on_init $term
150 257
185=item on_sel_extend $term 292=item on_sel_extend $term
186 293
187Called whenever the user tries to extend the selection (e.g. with a double 294Called whenever the user tries to extend the selection (e.g. with a double
188click) and is either supposed to return false (normal operation), or 295click) and is either supposed to return false (normal operation), or
189should extend the selection itelf and return true to suppress the built-in 296should extend the selection itelf and return true to suppress the built-in
190processing. 297processing. This can happen multiple times, as long as the callback
298returns true, it will be called on every further click by the user and is
299supposed to enlarge the selection more and more, if possible.
191 300
192See the F<selection> example extension. 301See the F<selection> example extension.
193 302
194=item on_view_change $term, $offset 303=item on_view_change $term, $offset
195 304
226can filter/change and output the text yourself by returning a true value 335can filter/change and output the text yourself by returning a true value
227and calling C<< $term->scr_add_lines >> yourself. Please note that this 336and calling C<< $term->scr_add_lines >> yourself. Please note that this
228might be very slow, however, as your hook is called for B<all> text being 337might be very slow, however, as your hook is called for B<all> text being
229output. 338output.
230 339
340=item on_tt_write $term, $octets
341
342Called whenever some data is written to the tty/pty and can be used to
343suppress or filter tty input.
344
231=item on_line_update $term, $row 345=item on_line_update $term, $row
232 346
233Called whenever a line was updated or changed. Can be used to filter 347Called whenever a line was updated or changed. Can be used to filter
234screen output (e.g. underline urls or other useless stuff). Only lines 348screen output (e.g. underline urls or other useless stuff). Only lines
235that are being shown will be filtered, and, due to performance reasons, 349that are being shown will be filtered, and, due to performance reasons,
257 371
258Called whenever the user presses a key combination that has a 372Called whenever the user presses a key combination that has a
259C<perl:string> action bound to it (see description of the B<keysym> 373C<perl:string> action bound to it (see description of the B<keysym>
260resource in the @@RXVT_NAME@@(1) manpage). 374resource in the @@RXVT_NAME@@(1) manpage).
261 375
376=item on_x_event $term, $event
377
378Called on every X event received on the vt window (and possibly other
379windows). Should only be used as a last resort. Most event structure
380members are not passed.
381
262=item on_focus_in $term 382=item on_focus_in $term
263 383
264Called whenever the window gets the keyboard focus, before rxvt-unicode 384Called whenever the window gets the keyboard focus, before rxvt-unicode
265does focus in processing. 385does focus in processing.
266 386
267=item on_focus_out $term 387=item on_focus_out $term
268 388
269Called wheneever the window loses keyboard focus, before rxvt-unicode does 389Called wheneever the window loses keyboard focus, before rxvt-unicode does
270focus out processing. 390focus out processing.
271 391
272=item on_key_press $term, $event, $octets 392=item on_key_press $term, $event, $keysym, $octets
273 393
274=item on_key_release $term, $event 394=item on_key_release $term, $event, $keysym
275 395
276=item on_button_press $term, $event 396=item on_button_press $term, $event
277 397
278=item on_button_release $term, $event 398=item on_button_release $term, $event
279 399
295 415
296subwindow. 416subwindow.
297 417
298=back 418=back
299 419
420=cut
421
422package urxvt;
423
424use utf8;
425use strict;
426use Carp ();
427use Scalar::Util ();
428use List::Util ();
429
430our $VERSION = 1;
431our $TERM;
432our @HOOKNAME;
433our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
434our %OPTION;
435
436our $LIBDIR;
437our $RESNAME;
438our $RESCLASS;
439our $RXVTNAME;
440
300=head2 Variables in the C<urxvt> Package 441=head2 Variables in the C<urxvt> Package
301 442
302=over 4 443=over 4
444
445=item $urxvt::LIBDIR
446
447The rxvt-unicode library directory, where, among other things, the perl
448modules and scripts are stored.
449
450=item $urxvt::RESCLASS, $urxvt::RESCLASS
451
452The resource class and name rxvt-unicode uses to look up X resources.
453
454=item $urxvt::RXVTNAME
455
456The basename of the installed binaries, usually C<urxvt>.
303 457
304=item $urxvt::TERM 458=item $urxvt::TERM
305 459
306The current terminal. This variable stores the current C<urxvt::term> 460The current terminal. This variable stores the current C<urxvt::term>
307object, whenever a callback/hook is executing. 461object, whenever a callback/hook is executing.
309=back 463=back
310 464
311=head2 Functions in the C<urxvt> Package 465=head2 Functions in the C<urxvt> Package
312 466
313=over 4 467=over 4
314
315=item $term = new urxvt [arg...]
316
317Creates a new terminal, very similar as if you had started it with
318C<system $binfile, arg...>. Croaks (and probably outputs an error message)
319if the new instance couldn't be created. Returns C<undef> if the new
320instance didn't initialise perl, and the terminal object otherwise. The
321C<init> and C<start> hooks will be called during the call.
322 468
323=item urxvt::fatal $errormessage 469=item urxvt::fatal $errormessage
324 470
325Fatally aborts execution with the given error message. Avoid at all 471Fatally aborts execution with the given error message. Avoid at all
326costs! The only time this is acceptable is when the terminal process 472costs! The only time this is acceptable is when the terminal process
333that calls this function. 479that calls this function.
334 480
335Using this function has the advantage that its output ends up in the 481Using this function has the advantage that its output ends up in the
336correct place, e.g. on stderr of the connecting urxvtc client. 482correct place, e.g. on stderr of the connecting urxvtc client.
337 483
484Messages have a size limit of 1023 bytes currently.
485
486=item $is_safe = urxvt::safe
487
488Returns true when it is safe to do potentially unsafe things, such as
489evaluating perl code specified by the user. This is true when urxvt was
490started setuid or setgid.
491
338=item $time = urxvt::NOW 492=item $time = urxvt::NOW
339 493
340Returns the "current time" (as per the event loop). 494Returns the "current time" (as per the event loop).
341 495
342=item urxvt::CurrentTime 496=item urxvt::CurrentTime
343 497
344=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 498=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
345Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 499Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
346Button4Mask, Button5Mask, AnyModifier 500Button4Mask, Button5Mask, AnyModifier
501
502=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
503ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
504PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
505Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
506KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
507ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
508FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
509
510=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
511EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
512GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
513UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
514ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
515CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
516SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
347 517
348Various constants for use in X calls and event processing. 518Various constants for use in X calls and event processing.
349 519
350=back 520=back
351 521
380 550
381=item $background = urxvt::GET_BASEBG $rend 551=item $background = urxvt::GET_BASEBG $rend
382 552
383Return the foreground/background colour index, respectively. 553Return the foreground/background colour index, respectively.
384 554
385=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) 555=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
386 556
387=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) 557=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
388 558
389Replace the foreground/background colour in the rendition mask with the 559Replace the foreground/background colour in the rendition mask with the
390specified one. 560specified one.
391 561
392=item $value = urxvt::GET_CUSTOM ($rend) 562=item $value = urxvt::GET_CUSTOM $rend
393 563
394Return the "custom" value: Every rendition has 5 bits for use by 564Return the "custom" value: Every rendition has 5 bits for use by
395extensions. They can be set and changed as you like and are initially 565extensions. They can be set and changed as you like and are initially
396zero. 566zero.
397 567
398=item $rend = urxvt::SET_CUSTOM ($rend, $new_value) 568=item $rend = urxvt::SET_CUSTOM $rend, $new_value
399 569
400Change the custom value. 570Change the custom value.
401 571
402=back 572=back
403 573
404=cut 574=cut
405
406package urxvt;
407
408use utf8;
409use strict;
410use Scalar::Util ();
411use List::Util ();
412
413our $VERSION = 1;
414our $TERM;
415our @HOOKNAME;
416our %OPTION;
417our $LIBDIR;
418 575
419BEGIN { 576BEGIN {
420 urxvt->bootstrap; 577 urxvt->bootstrap;
421 578
422 # overwrite perl's warn 579 # overwrite perl's warn
425 $msg .= "\n" 582 $msg .= "\n"
426 unless $msg =~ /\n$/; 583 unless $msg =~ /\n$/;
427 urxvt::warn ($msg); 584 urxvt::warn ($msg);
428 }; 585 };
429 586
587 # %ENV is the original startup environment
430 delete $ENV{IFS}; 588 delete $ENV{IFS};
431 delete $ENV{CDPATH}; 589 delete $ENV{CDPATH};
432 delete $ENV{BASH_ENV}; 590 delete $ENV{BASH_ENV};
433 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; 591 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
434} 592}
435 593
436my @hook_count;
437my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 594my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
438 595
439sub verbose { 596sub verbose {
440 my ($level, $msg) = @_; 597 my ($level, $msg) = @_;
441 warn "$msg\n" if $level <= $verbosity; 598 warn "$msg\n" if $level <= $verbosity;
442} 599}
443 600
444# find on_xxx subs in the package and register them
445# as hooks
446sub register_package($) {
447 my ($pkg) = @_;
448
449 for my $htype (0.. $#HOOKNAME) {
450 my $name = $HOOKNAME[$htype];
451
452 my $ref = $pkg->can ("on_" . lc $name)
453 or next;
454
455 $TERM->{_hook}[$htype]{$pkg} = $ref;
456 $hook_count[$htype]++
457 or set_should_invoke $htype, 1;
458 }
459}
460
461my $extension_pkg = "extension0000"; 601my $extension_pkg = "extension0000";
462my %extension_pkg; 602my %extension_pkg;
463 603
464# load a single script into its own package, once only 604# load a single script into its own package, once only
465sub extension_package($) { 605sub extension_package($) {
471 verbose 3, "loading extension '$path' into package '$pkg'"; 611 verbose 3, "loading extension '$path' into package '$pkg'";
472 612
473 open my $fh, "<:raw", $path 613 open my $fh, "<:raw", $path
474 or die "$path: $!"; 614 or die "$path: $!";
475 615
616 my $source = untaint
476 my $source = untaint "package $pkg; use strict; use utf8;\n" 617 "package $pkg; use strict; use utf8;\n"
477 . "use base urxvt::term::proxy::;\n" 618 . "use base urxvt::term::extension::;\n"
478 . "#line 1 \"$path\"\n{\n" 619 . "#line 1 \"$path\"\n{\n"
479 . (do { local $/; <$fh> }) 620 . (do { local $/; <$fh> })
480 . "\n};\n1"; 621 . "\n};\n1";
481 622
623 eval $source
482 eval $source or die "$path: $@"; 624 or die "$path: $@";
483 625
484 $pkg 626 $pkg
485 } 627 }
486} 628}
487 629
493 my $htype = shift; 635 my $htype = shift;
494 636
495 if ($htype == 0) { # INIT 637 if ($htype == 0) { # INIT
496 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 638 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
497 639
498 my %want_ext; 640 my %ext_arg;
499 641
500 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 642 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
501 if ($_ eq "default") { 643 if ($_ eq "default") {
502 $want_ext{$_}++ for qw(selection option-popup selection-popup); 644 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
503 } elsif (/^-(.*)$/) { 645 } elsif (/^-(.*)$/) {
504 delete $want_ext{$1}; 646 delete $ext_arg{$1};
647 } elsif (/^([^<]+)<(.*)>$/) {
648 push @{ $ext_arg{$1} }, $2;
505 } else { 649 } else {
506 $want_ext{$_}++; 650 $ext_arg{$_} ||= [];
507 } 651 }
508 } 652 }
509 653
510 for my $ext (keys %want_ext) { 654 while (my ($ext, $argv) = each %ext_arg) {
511 my @files = grep -f $_, map "$_/$ext", @dirs; 655 my @files = grep -f $_, map "$_/$ext", @dirs;
512 656
513 if (@files) { 657 if (@files) {
514 register_package extension_package $files[0]; 658 $TERM->register_package (extension_package $files[0], $argv);
515 } else { 659 } else {
516 warn "perl extension '$ext' not found in perl library search path\n"; 660 warn "perl extension '$ext' not found in perl library search path\n";
517 } 661 }
518 } 662 }
519 663
528 if $verbosity >= 10; 672 if $verbosity >= 10;
529 673
530 keys %$cb; 674 keys %$cb;
531 675
532 while (my ($pkg, $cb) = each %$cb) { 676 while (my ($pkg, $cb) = each %$cb) {
533 eval { 677 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
534 $retval = $cb->(
535 $TERM->{_pkg}{$pkg} ||= do {
536 my $proxy = bless { }, $pkg;
537 Scalar::Util::weaken ($proxy->{term} = $TERM);
538 $proxy
539 },
540 @_,
541 ) and last; 678 and last;
542 }; 679
543 if ($@) { 680 if ($@) {
544 $TERM->ungrab; # better to lose the grab than the session 681 $TERM->ungrab; # better to lose the grab than the session
545 warn $@; 682 warn $@;
546 } 683 }
547 } 684 }
685
686 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
687 if $verbosity >= 11;
548 } 688 }
549 689
550 if ($htype == 1) { # DESTROY 690 if ($htype == 1) { # DESTROY
551 # remove hooks if unused
552 if (my $hook = $TERM->{_hook}) {
553 for my $htype (0..$#$hook) {
554 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
555 or set_should_invoke $htype, 0;
556 }
557 }
558
559 # clear package objects 691 # clear package objects
560 %$_ = () for values %{ $TERM->{_pkg} }; 692 %$_ = () for values %{ $TERM->{_pkg} };
561 693
562 # clear package 694 # clear package
563 %$TERM = (); 695 %$TERM = ();
564 } 696 }
565 697
566 $retval 698 $retval
567} 699}
568 700
569# urxvt::term::proxy 701sub exec_async(@) {
702 my $pid = fork;
570 703
571sub urxvt::term::proxy::AUTOLOAD { 704 return
572 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 705 if !defined $pid or $pid;
706
707 %ENV = %{ $TERM->env };
708
709 exec @_;
710 _exit 255;
711}
712
713# urxvt::term::extension
714
715package urxvt::term::extension;
716
717sub enable {
718 my ($self, %hook) = @_;
719 my $pkg = $self->{_pkg};
720
721 while (my ($name, $cb) = each %hook) {
722 my $htype = $HOOKTYPE{uc $name};
723 defined $htype
724 or Carp::croak "unsupported hook type '$name'";
725
726 $self->set_should_invoke ($htype, +1)
727 unless exists $self->{term}{_hook}[$htype]{$pkg};
728
729 $self->{term}{_hook}[$htype]{$pkg} = $cb;
730 }
731}
732
733sub disable {
734 my ($self, @hook) = @_;
735 my $pkg = $self->{_pkg};
736
737 for my $name (@hook) {
738 my $htype = $HOOKTYPE{uc $name};
739 defined $htype
740 or Carp::croak "unsupported hook type '$name'";
741
742 $self->set_should_invoke ($htype, -1)
743 if delete $self->{term}{_hook}[$htype]{$pkg};
744 }
745}
746
747our $AUTOLOAD;
748
749sub AUTOLOAD {
750 $AUTOLOAD =~ /:([^:]+)$/
573 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 751 or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
574 752
575 eval qq{ 753 eval qq{
576 sub $urxvt::term::proxy::AUTOLOAD { 754 sub $AUTOLOAD {
577 my \$proxy = shift; 755 my \$proxy = shift;
578 \$proxy->{term}->$1 (\@_) 756 \$proxy->{term}->$1 (\@_)
579 } 757 }
580 1 758 1
581 } or die "FATAL: unable to compile method forwarder: $@"; 759 } or die "FATAL: unable to compile method forwarder: $@";
582 760
583 goto &$urxvt::term::proxy::AUTOLOAD; 761 goto &$AUTOLOAD;
584} 762}
585 763
586sub urxvt::term::proxy::DESTROY { 764sub DESTROY {
587 # nop 765 # nop
588} 766}
589 767
590# urxvt::destroy_hook 768# urxvt::destroy_hook
591 769
601 779
602=head2 The C<urxvt::anyevent> Class 780=head2 The C<urxvt::anyevent> Class
603 781
604The sole purpose of this class is to deliver an interface to the 782The sole purpose of this class is to deliver an interface to the
605C<AnyEvent> module - any module using it will work inside urxvt without 783C<AnyEvent> module - any module using it will work inside urxvt without
606further work. The only exception is that you cannot wait on condition 784further programming. The only exception is that you cannot wait on
607variables, but non-blocking condvar use is ok. What this means is that you 785condition variables, but non-blocking condvar use is ok. What this means
608cannot use blocking APIs, but the non-blocking variant should work. 786is that you cannot use blocking APIs, but the non-blocking variant should
787work.
609 788
610=cut 789=cut
611 790
612our $VERSION = 1; 791our $VERSION = 1;
613 792
658 ${$_[0]}++; 837 ${$_[0]}++;
659} 838}
660 839
661sub urxvt::anyevent::condvar::wait { 840sub urxvt::anyevent::condvar::wait {
662 unless (${$_[0]}) { 841 unless (${$_[0]}) {
663 require Carp;
664 Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"); 842 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
665 } 843 }
666} 844}
667 845
668package urxvt::term; 846package urxvt::term;
669 847
670=head2 The C<urxvt::term> Class 848=head2 The C<urxvt::term> Class
671 849
672=over 4 850=over 4
673 851
852=cut
853
854# find on_xxx subs in the package and register them
855# as hooks
856sub register_package {
857 my ($self, $pkg, $argv) = @_;
858
859 my $proxy = bless {
860 _pkg => $pkg,
861 argv => $argv,
862 }, $pkg;
863 Scalar::Util::weaken ($proxy->{term} = $self);
864
865 $self->{_pkg}{$pkg} = $proxy;
866
867 for my $name (@HOOKNAME) {
868 if (my $ref = $pkg->can ("on_" . lc $name)) {
869 $proxy->enable ($name => $ref);
870 }
871 }
872}
873
874=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
875
876Creates a new terminal, very similar as if you had started it with system
877C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
878hash which defines the environment of the new terminal.
879
880Croaks (and probably outputs an error message) if the new instance
881couldn't be created. Returns C<undef> if the new instance didn't
882initialise perl, and the terminal object otherwise. The C<init> and
883C<start> hooks will be called during this call.
884
885=cut
886
887sub new {
888 my ($class, $env, @args) = @_;
889
890 _new ([ map "$_=$env->{$_}", keys %$env ], @args);
891}
892
674=item $term->destroy 893=item $term->destroy
675 894
676Destroy the terminal object (close the window, free resources etc.). 895Destroy the terminal object (close the window, free resources
896etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
897watchers (timers, io watchers) are still active.
677 898
678=item $isset = $term->option ($optval[, $set]) 899=item $isset = $term->option ($optval[, $set])
679 900
680Returns true if the option specified by C<$optval> is enabled, and 901Returns true if the option specified by C<$optval> is enabled, and
681optionally change it. All option values are stored by name in the hash 902optionally change it. All option values are stored by name in the hash
731 my ($self, $name) = (shift, shift); 952 my ($self, $name) = (shift, shift);
732 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 953 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
733 &urxvt::term::_resource 954 &urxvt::term::_resource
734} 955}
735 956
957=item $value = $term->x_resource ($pattern)
958
959Returns the X-Resource for the given pattern, excluding the program or
960class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
961same value as used by this instance of rxvt-unicode. Returns C<undef> if no
962resource with that pattern exists.
963
964This method should only be called during the C<on_start> hook, as there is
965only one resource database per display, and later invocations might return
966the wrong resources.
967
968=item $success = $term->parse_keysym ($keysym_spec, $command_string)
969
970Adds a keymap translation exactly as specified via a resource. See the
971C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
972
736=item $rend = $term->rstyle ([$new_rstyle]) 973=item $rend = $term->rstyle ([$new_rstyle])
737 974
738Return and optionally change the current rendition. Text that is output by 975Return and optionally change the current rendition. Text that is output by
739the terminal application will use this style. 976the terminal application will use this style.
740 977
750=item ($row, $col) = $term->selection_end ([$row, $col]) 987=item ($row, $col) = $term->selection_end ([$row, $col])
751 988
752Return the current values of the selection mark, begin or end positions, 989Return the current values of the selection mark, begin or end positions,
753and optionally set them to new values. 990and optionally set them to new values.
754 991
992=item $term->selection_make ($eventtime[, $rectangular])
993
994Tries to make a selection as set by C<selection_beg> and
995C<selection_end>. If C<$rectangular> is true (default: false), a
996rectangular selection will be made. This is the prefered function to make
997a selection.
998
755=item $success = $term->selection_grab ($eventtime) 999=item $success = $term->selection_grab ($eventtime)
756 1000
757Try to request the primary selection from the server (for example, as set 1001Try to request the primary selection text from the server (for example, as
758by the next method). 1002set by the next method). No visual feedback will be given. This function
1003is mostly useful from within C<on_sel_grab> hooks.
759 1004
760=item $oldtext = $term->selection ([$newtext]) 1005=item $oldtext = $term->selection ([$newtext])
761 1006
762Return the current selection text and optionally replace it by C<$newtext>. 1007Return the current selection text and optionally replace it by C<$newtext>.
763 1008
764#=item $term->overlay ($x, $y, $text) 1009=item $term->overlay_simple ($x, $y, $text)
765# 1010
766#Create a simple multi-line overlay box. See the next method for details. 1011Create a simple multi-line overlay box. See the next method for details.
767# 1012
768#=cut 1013=cut
769# 1014
770#sub urxvt::term::scr_overlay { 1015sub overlay_simple {
771# my ($self, $x, $y, $text) = @_; 1016 my ($self, $x, $y, $text) = @_;
772# 1017
773# my @lines = split /\n/, $text; 1018 my @lines = split /\n/, $text;
774# 1019
775# my $w = 0; 1020 my $w = List::Util::max map $self->strwidth ($_), @lines;
776# for (map $self->strwidth ($_), @lines) { 1021
777# $w = $_ if $w < $_;
778# }
779#
780# $self->scr_overlay_new ($x, $y, $w, scalar @lines); 1022 my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
781# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; 1023 $overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
782#} 1024
1025 $overlay
1026}
783 1027
784=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) 1028=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
785 1029
786Create a new (empty) overlay at the given position with the given 1030Create a new (empty) overlay at the given position with the given
787width/height. C<$rstyle> defines the initial rendition style 1031width/height. C<$rstyle> defines the initial rendition style
854 1098
855=item $string = $term->locale_decode ($octets) 1099=item $string = $term->locale_decode ($octets)
856 1100
857Convert the given locale-encoded octets into a perl string. 1101Convert the given locale-encoded octets into a perl string.
858 1102
1103=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1104
1105XORs the rendition values in the given span with the provided value
1106(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
1107refresh hooks to provide effects similar to the selection.
1108
1109=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1110
1111Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1112whitespace will additionally be xored with the C<$rstyle2>, which defaults
1113to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1114it instead. Both styles I<MUST NOT> contain font styles.
1115
1116=item $term->scr_bell
1117
1118Ring the bell!
1119
859=item $term->scr_add_lines ($string) 1120=item $term->scr_add_lines ($string)
860 1121
861Write the given text string to the screen, as if output by the application 1122Write the given text string to the screen, as if output by the application
862running inside the terminal. It may not contain command sequences (escape 1123running inside the terminal. It may not contain command sequences (escape
863codes), but is free to use line feeds, carriage returns and tabs. The 1124codes), but is free to use line feeds, carriage returns and tabs. The
877 1138
878Write the octets given in C<$data> to the tty (i.e. as program input). To 1139Write the octets given in C<$data> to the tty (i.e. as program input). To
879pass characters instead of octets, you should convert your strings first 1140pass characters instead of octets, you should convert your strings first
880to the locale-specific encoding using C<< $term->locale_encode >>. 1141to the locale-specific encoding using C<< $term->locale_encode >>.
881 1142
1143=item $old_events = $term->pty_ev_events ([$new_events])
1144
1145Replaces the event mask of the pty watcher by the given event mask. Can
1146be used to suppress input and output handling to the pty/tty. See the
1147description of C<< urxvt::timer->events >>. Make sure to always restore
1148the previous value.
1149
882=item $windowid = $term->parent 1150=item $windowid = $term->parent
883 1151
884Return the window id of the toplevel window. 1152Return the window id of the toplevel window.
885 1153
886=item $windowid = $term->vt 1154=item $windowid = $term->vt
887 1155
888Return the window id of the terminal window. 1156Return the window id of the terminal window.
889 1157
1158=item $term->vt_emask_add ($x_event_mask)
1159
1160Adds the specified events to the vt event mask. Useful e.g. when you want
1161to receive pointer events all the times:
1162
1163 $term->vt_emask_add (urxvt::PointerMotionMask);
1164
890=item $window_width = $term->width 1165=item $window_width = $term->width
891 1166
892=item $window_height = $term->height 1167=item $window_height = $term->height
893 1168
894=item $font_width = $term->fwidth 1169=item $font_width = $term->fwidth
910=item $nrow_plus_saveLines = $term->total_rows 1185=item $nrow_plus_saveLines = $term->total_rows
911 1186
912=item $lines_in_scrollback = $term->nsaved 1187=item $lines_in_scrollback = $term->nsaved
913 1188
914Return various integers describing terminal characteristics. 1189Return various integers describing terminal characteristics.
1190
1191=item $x_display = $term->display_id
1192
1193Return the DISPLAY used by rxvt-unicode.
1194
1195=item $lc_ctype = $term->locale
1196
1197Returns the LC_CTYPE category string used by this rxvt-unicode.
1198
1199=item $env = $term->env
1200
1201Returns a copy of the environment in effect for the terminal as a hashref
1202similar to C<\%ENV>.
1203
1204=cut
1205
1206sub env {
1207 if (my $env = $_[0]->_env) {
1208 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
1209 } else {
1210 +{ %ENV }
1211 }
1212}
915 1213
916=item $modifiermask = $term->ModLevel3Mask 1214=item $modifiermask = $term->ModLevel3Mask
917 1215
918=item $modifiermask = $term->ModMetaMask 1216=item $modifiermask = $term->ModMetaMask
919 1217
1012Return the row number of the first/last row of the line, respectively. 1310Return the row number of the first/last row of the line, respectively.
1013 1311
1014=item $offset = $line->offset_of ($row, $col) 1312=item $offset = $line->offset_of ($row, $col)
1015 1313
1016Returns the character offset of the given row|col pair within the logical 1314Returns the character offset of the given row|col pair within the logical
1017line. 1315line. Works for rows outside the line, too, and returns corresponding
1316offsets outside the string.
1018 1317
1019=item ($row, $col) = $line->coord_of ($offset) 1318=item ($row, $col) = $line->coord_of ($offset)
1020 1319
1021Translates a string offset into terminal coordinates again. 1320Translates a string offset into terminal coordinates again.
1022 1321
1109Converts rxvt-unicodes text reprsentation into a perl string. See 1408Converts rxvt-unicodes text reprsentation into a perl string. See
1110C<< $term->ROW_t >> for details. 1409C<< $term->ROW_t >> for details.
1111 1410
1112=item $success = $term->grab_button ($button, $modifiermask) 1411=item $success = $term->grab_button ($button, $modifiermask)
1113 1412
1114Registers a synchronous button grab. See XGrabButton. 1413Registers a synchronous button grab. See the XGrabButton manpage.
1115 1414
1116=item $success = $term->grab ($eventtime[, $sync]) 1415=item $success = $term->grab ($eventtime[, $sync])
1117 1416
1118Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1417Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1119synchronous (C<$sync> is true). Also remembers the grab timestampe. 1418synchronous (C<$sync> is true). Also remembers the grab timestampe.
1159 $item->{render} ||= sub { $_[0]{text} }; 1458 $item->{render} ||= sub { $_[0]{text} };
1160 1459
1161 push @{ $self->{item} }, $item; 1460 push @{ $self->{item} }, $item;
1162} 1461}
1163 1462
1164sub add_separator { 1463=item $popup->add_title ($title)
1165 my ($self, $sep) = @_;
1166 1464
1167 $sep ||= "═"; 1465Adds a non-clickable title to the popup.
1168 1466
1169 $self->add_item ({ 1467=cut
1170 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1171 text => "",
1172 render => sub { $sep x $urxvt::TERM->ncol },
1173 activate => sub { },
1174 });
1175}
1176 1468
1177sub add_title { 1469sub add_title {
1178 my ($self, $title) = @_; 1470 my ($self, $title) = @_;
1179 1471
1180 $self->add_item ({ 1472 $self->add_item ({
1182 text => $title, 1474 text => $title,
1183 activate => sub { }, 1475 activate => sub { },
1184 }); 1476 });
1185} 1477}
1186 1478
1479=item $popup->add_separator ([$sepchr])
1480
1481Creates a separator, optionally using the character given as C<$sepchr>.
1482
1483=cut
1484
1485sub add_separator {
1486 my ($self, $sep) = @_;
1487
1488 $sep ||= "=";
1489
1490 $self->add_item ({
1491 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1492 text => "",
1493 render => sub { $sep x $self->{term}->ncol },
1494 activate => sub { },
1495 });
1496}
1497
1498=item $popup->add_button ($text, $cb)
1499
1500Adds a clickable button to the popup. C<$cb> is called whenever it is
1501selected.
1502
1503=cut
1504
1187sub add_button { 1505sub add_button {
1188 my ($self, $text, $cb) = @_; 1506 my ($self, $text, $cb) = @_;
1189 1507
1190 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb}); 1508 $self->add_item ({ type => "button", text => $text, activate => $cb});
1191} 1509}
1510
1511=item $popup->add_toggle ($text, $cb, $initial_value)
1512
1513Adds a toggle/checkbox item to the popup. Teh callback gets called
1514whenever it gets toggled, with a boolean indicating its value as its first
1515argument.
1516
1517=cut
1192 1518
1193sub add_toggle { 1519sub add_toggle {
1194 my ($self, $text, $cb, $value) = @_; 1520 my ($self, $text, $cb, $value) = @_;
1195 1521
1196 my $item; $item = { 1522 my $item; $item = {
1197 type => "button", 1523 type => "button",
1198 text => " $text", 1524 text => " $text",
1199 value => $value, 1525 value => $value,
1200 render => sub { ($_[0]{value} ? "* " : " ") . $text }, 1526 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1201 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); }, 1527 activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1202 }; 1528 };
1203 1529
1204 $self->add_item ($item); 1530 $self->add_item ($item);
1205} 1531}
1532
1533=item $popup->show
1534
1535Displays the popup (which is initially hidden).
1536
1537=cut
1206 1538
1207sub show { 1539sub show {
1208 my ($self) = @_; 1540 my ($self) = @_;
1209 1541
1210 local $urxvt::popup::self = $self; 1542 local $urxvt::popup::self = $self;
1211 1543
1544 my $env = $self->{term}->env;
1545 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1546 delete $env->{LC_ALL};
1547 $env->{LC_CTYPE} = $self->{term}->locale;
1548
1549 urxvt::term->new ($env, $self->{term}->resource ("name"),
1212 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1550 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1213 "--transient-for" => $self->{term}->parent, 1551 "--transient-for" => $self->{term}->parent,
1552 "-display" => $self->{term}->display_id,
1214 "-pe" => "urxvt-popup") 1553 "-pe" => "urxvt-popup")
1215 or die "unable to create popup window\n"; 1554 or die "unable to create popup window\n";
1216} 1555}
1217 1556
1218sub DESTROY { 1557sub DESTROY {
1219 my ($self) = @_; 1558 my ($self) = @_;
1220 1559
1221 delete $self->{term}{_destroy}{$self}; 1560 delete $self->{term}{_destroy}{$self};
1222 $self->{term}->ungrab; 1561 $self->{term}->ungrab;
1223} 1562}
1563
1564=back
1224 1565
1225=head2 The C<urxvt::timer> Class 1566=head2 The C<urxvt::timer> Class
1226 1567
1227This class implements timer watchers/events. Time is represented as a 1568This class implements timer watchers/events. Time is represented as a
1228fractional number of seconds since the epoch. Example: 1569fractional number of seconds since the epoch. Example:
1281 1622
1282 $term->{socket} = ... 1623 $term->{socket} = ...
1283 $term->{iow} = urxvt::iow 1624 $term->{iow} = urxvt::iow
1284 ->new 1625 ->new
1285 ->fd (fileno $term->{socket}) 1626 ->fd (fileno $term->{socket})
1286 ->events (1) # wait for read data 1627 ->events (urxvt::EVENT_READ)
1287 ->start 1628 ->start
1288 ->cb (sub { 1629 ->cb (sub {
1289 my ($iow, $revents) = @_; 1630 my ($iow, $revents) = @_;
1290 # $revents must be 1 here, no need to check 1631 # $revents must be 1 here, no need to check
1291 sysread $term->{socket}, my $buf, 8192 1632 sysread $term->{socket}, my $buf, 8192
1308 1649
1309Set the filedescriptor (not handle) to watch. 1650Set the filedescriptor (not handle) to watch.
1310 1651
1311=item $iow = $iow->events ($eventmask) 1652=item $iow = $iow->events ($eventmask)
1312 1653
1313Set the event mask to watch. Bit #0 (value C<1>) enables watching for read 1654Set the event mask to watch. The only allowed values are
1314data, Bit #1 (value C<2>) enables watching for write data. 1655C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
1656together, or C<urxvt::EVENT_NONE>.
1315 1657
1316=item $iow = $iow->start 1658=item $iow = $iow->start
1317 1659
1318Start watching for requested events on the given handle. 1660Start watching for requested events on the given handle.
1319 1661
1334 1676
1335=item == 0 - fatal messages 1677=item == 0 - fatal messages
1336 1678
1337=item >= 3 - script loading and management 1679=item >= 3 - script loading and management
1338 1680
1339=item >=10 - all events received 1681=item >=10 - all called hooks
1682
1683=item >=11 - hook reutrn values
1340 1684
1341=back 1685=back
1342 1686
1343=head1 AUTHOR 1687=head1 AUTHOR
1344 1688

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines