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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines