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.29 by root, Wed Jan 4 00:12:12 2006 UTC vs.
Revision 1.74 by root, Tue Jan 10 04:26:54 2006 UTC

17 17
18 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test 18 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19 19
20=head1 DESCRIPTION 20=head1 DESCRIPTION
21 21
22Everytime a terminal object gets created, scripts specified via the 22Everytime a terminal object gets created, extension scripts specified via
23C<perl> resource are loaded and associated with it. 23the C<perl> resource are loaded and associated with it.
24 24
25Scripts are compiled in a 'use strict' and 'use utf8' environment, and 25Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26thus must be encoded as UTF-8. 26thus must be encoded as UTF-8.
27 27
28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where 28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
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 44Intelligent selection. This extension tries to be more intelligent when
45the user extends selections (double-click). Right now, it tries to select 45the user extends selections (double-click). Right now, it tries to select
46urls and complete shell-quoted arguments, which is very convenient, too, 46urls and complete shell-quoted arguments, which is very convenient, too,
47if your F<ls> supports C<--quoting-style=shell>. 47if your F<ls> supports C<--quoting-style=shell>.
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.
70
71=item searchable-scrollback<hotkey> (enabled by default)
72
73Adds regex search functionality to the scrollback buffer, triggered
74by a hotkey (default: C<M-s>). When in search mode, normal terminal
75input/output is suspended.
76
77C</> starts an incremental regex search, C<n> searches further, C<p> or
78C<N> jump to the previous match, C<G> jumps to the bottom and clears the
79history, C<enter> leaves search mode at the current position and C<escape>
80returns to the original position.
81
61=item digital-clock 82=item digital-clock
62 83
63Displays a digital clock using the built-in overlay. 84Displays a digital clock using the built-in overlay.
85
86=item mark-urls
87
88Uses per-line display filtering (C<on_line_update>) to underline urls.
89
90=item block-graphics-to-ascii
91
92A not very useful example of filtering all text output to the terminal,
93by replacing all line-drawing characters (U+2500 .. U+259F) by a
94similar-looking ascii character.
64 95
65=item example-refresh-hooks 96=item example-refresh-hooks
66 97
67Displays a very simple digital clock in the upper right corner of the 98Displays a very simple digital clock in the upper right corner of the
68window. Illustrates overwriting the refresh callbacks to create your own 99window. Illustrates overwriting the refresh callbacks to create your own
81When objects are destroyed on the C++ side, the perl object hashes are 112When objects are destroyed on the C++ side, the perl object hashes are
82emptied, so its best to store related objects such as time watchers and 113emptied, so its best to store related objects such as time watchers and
83the like inside the terminal object so they get destroyed as soon as the 114the like inside the terminal object so they get destroyed as soon as the
84terminal is destroyed. 115terminal is destroyed.
85 116
117Argument names also often indicate the type of a parameter. Here are some
118hints on what they mean:
119
120=over 4
121
122=item $text
123
124Rxvt-unicodes special way of encoding text, where one "unicode" character
125always represents one screen cell. See L<row_t> for a discussion of this format.
126
127=item $string
128
129A perl text string, with an emphasis on I<text>. It can store all unicode
130characters and is to be distinguished with text encoded in a specific
131encoding (often locale-specific) and binary data.
132
133=item $octets
134
135Either binary data or - more common - a text string encoded in a
136locale-specific way.
137
138=back
139
140=head2 Extension Objects
141
142Very perl extension is a perl class. A separate perl object is created
143for each terminal and each extension and passed as the first parameter to
144hooks. So extensions can use their C<$self> object without having to think
145about other extensions, with the exception of methods and members that
146begin with an underscore character C<_>: these are reserved for internal
147use.
148
149Although it isn't a C<urxvt::term> object, you can call all methods of the
150C<urxvt::term> class on this object.
151
152It has the following methods and data members:
153
154=over 4
155
156=item $urxvt_term = $self->{term}
157
158Returns the C<urxvt::term> object associated with this instance of the
159extension. This member I<must not> be changed in any way.
160
161=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
162
163Dynamically enable the given hooks (named without the C<on_> prefix) for
164this extension, replacing any previous hook. This is useful when you want
165to overwrite time-critical hooks only temporarily.
166
167=item $self->disable ($hook_name[, $hook_name..])
168
169Dynamically disable the given hooks.
170
171=back
172
86=head2 Hooks 173=head2 Hooks
87 174
88The following subroutines can be declared in loaded scripts, and will be 175The following subroutines can be declared in extension files, and will be
89called whenever the relevant event happens. 176called whenever the relevant event happens.
90 177
91The first argument passed to them is an object private to each terminal 178The first argument passed to them is an extension oject as described in
92and extension package. You can call all C<urxvt::term> methods on it, but 179the in the C<Extension Objects> section.
93its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
94object that is shared between all packages is stored in the C<term>
95member.
96 180
97All of them must return a boolean value. If it is true, then the event 181B<All> of these hooks must return a boolean value. If it is true, then the
98counts as being I<consumed>, and the invocation of other hooks is skipped, 182event counts as being I<consumed>, and the invocation of other hooks is
99and the relevant action might not be carried out by the C++ code. 183skipped, and the relevant action might not be carried out by the C++ code.
100 184
101When in doubt, return a false value (preferably C<()>). 185I<< When in doubt, return a false value (preferably C<()>). >>
102 186
103=over 4 187=over 4
104 188
105=item on_init $term 189=item on_init $term
106 190
107Called after a new terminal object has been initialized, but before 191Called after a new terminal object has been initialized, but before
108windows are created or the command gets run. 192windows are created or the command gets run. Most methods are unsafe to
193call or deliver senseless data, as terminal size and other characteristics
194have not yet been determined. You can safely query and change resources,
195though.
109 196
110=item on_reset $term 197=item on_reset $term
111 198
112Called after the screen is "reset" for any reason, such as resizing or 199Called after the screen is "reset" for any reason, such as resizing or
113control sequences. Here is where you can react on changes to size-related 200control sequences. Here is where you can react on changes to size-related
142should extend the selection itelf and return true to suppress the built-in 229should extend the selection itelf and return true to suppress the built-in
143processing. 230processing.
144 231
145See the F<selection> example extension. 232See the F<selection> example extension.
146 233
147=item on_focus_in $term
148
149Called whenever the window gets the keyboard focus, before urxvt does
150focus in processing.
151
152=item on_focus_out $term
153
154Called wheneever the window loses keyboard focus, before urxvt does focus
155out processing.
156
157=item on_view_change $term, $offset 234=item on_view_change $term, $offset
158 235
159Called whenever the view offset changes, i..e the user or program 236Called whenever the view offset changes, i..e the user or program
160scrolls. Offset C<0> means display the normal terminal, positive values 237scrolls. Offset C<0> means display the normal terminal, positive values
161show this many lines of scrollback. 238show this many lines of scrollback.
167than the scroll back buffer or the terminal. 244than the scroll back buffer or the terminal.
168 245
169It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 246It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
170$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 247$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
171number of lines that will be in the scrollback buffer. 248number of lines that will be in the scrollback buffer.
172
173=item on_tty_activity $term *NYI*
174
175Called whenever the program(s) running in the urxvt window send output.
176 249
177=item on_osc_seq $term, $string 250=item on_osc_seq $term, $string
178 251
179Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 252Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
180operating system command) is processed. Cursor position and other state 253operating system command) is processed. Cursor position and other state
185 258
186Be careful not ever to trust (in a security sense) the data you receive, 259Be careful not ever to trust (in a security sense) the data you receive,
187as its source can not easily be controleld (e-mail content, messages from 260as its source can not easily be controleld (e-mail content, messages from
188other users on the same system etc.). 261other users on the same system etc.).
189 262
263=item on_add_lines $term, $string
264
265Called whenever text is about to be output, with the text as argument. You
266can filter/change and output the text yourself by returning a true value
267and calling C<< $term->scr_add_lines >> yourself. Please note that this
268might be very slow, however, as your hook is called for B<all> text being
269output.
270
271=item on_tt_write $term, $octets
272
273Called whenever some data is written to the tty/pty and can be used to
274suppress or filter tty input.
275
276=item on_line_update $term, $row
277
278Called whenever a line was updated or changed. Can be used to filter
279screen output (e.g. underline urls or other useless stuff). Only lines
280that are being shown will be filtered, and, due to performance reasons,
281not always immediately.
282
283The row number is always the topmost row of the line if the line spans
284multiple rows.
285
286Please note that, if you change the line, then the hook might get called
287later with the already-modified line (e.g. if unrelated parts change), so
288you cannot just toggle rendition bits, but only set them.
289
190=item on_refresh_begin $term 290=item on_refresh_begin $term
191 291
192Called just before the screen gets redrawn. Can be used for overlay 292Called just before the screen gets redrawn. Can be used for overlay
193or similar effects by modify terminal contents in refresh_begin, and 293or similar effects by modify terminal contents in refresh_begin, and
194restoring them in refresh_end. The built-in overlay and selection display 294restoring them in refresh_end. The built-in overlay and selection display
202 302
203Called whenever the user presses a key combination that has a 303Called whenever the user presses a key combination that has a
204C<perl:string> action bound to it (see description of the B<keysym> 304C<perl:string> action bound to it (see description of the B<keysym>
205resource in the @@RXVT_NAME@@(1) manpage). 305resource in the @@RXVT_NAME@@(1) manpage).
206 306
307=item on_focus_in $term
308
309Called whenever the window gets the keyboard focus, before rxvt-unicode
310does focus in processing.
311
312=item on_focus_out $term
313
314Called wheneever the window loses keyboard focus, before rxvt-unicode does
315focus out processing.
316
317=item on_key_press $term, $event, $keysym, $octets
318
319=item on_key_release $term, $event, $keysym
320
321=item on_button_press $term, $event
322
323=item on_button_release $term, $event
324
325=item on_motion_notify $term, $event
326
327=item on_map_notify $term, $event
328
329=item on_unmap_notify $term, $event
330
331Called whenever the corresponding X event is received for the terminal If
332the hook returns true, then the even will be ignored by rxvt-unicode.
333
334The event is a hash with most values as named by Xlib (see the XEvent
335manpage), with the additional members C<row> and C<col>, which are the row
336and column under the mouse cursor.
337
338C<on_key_press> additionally receives the string rxvt-unicode would
339output, if any, in locale-specific encoding.
340
341subwindow.
342
207=back 343=back
208 344
209=head2 Variables in the C<urxvt> Package 345=head2 Variables in the C<urxvt> Package
210 346
211=over 4 347=over 4
212 348
213=item $urxvt::TERM 349=item $urxvt::TERM
214 350
215The current terminal. Whenever a callback/Hook is bein executed, this 351The current terminal. This variable stores the current C<urxvt::term>
216variable stores the current C<urxvt::term> object. 352object, whenever a callback/hook is executing.
217 353
218=back 354=back
219 355
220=head2 Functions in the C<urxvt> Package 356=head2 Functions in the C<urxvt> Package
221 357
222=over 4 358=over 4
359
360=item $term = new urxvt [arg...]
361
362Creates a new terminal, very similar as if you had started it with
363C<system $binfile, arg...>. Croaks (and probably outputs an error message)
364if the new instance couldn't be created. Returns C<undef> if the new
365instance didn't initialise perl, and the terminal object otherwise. The
366C<init> and C<start> hooks will be called during the call.
223 367
224=item urxvt::fatal $errormessage 368=item urxvt::fatal $errormessage
225 369
226Fatally aborts execution with the given error message. Avoid at all 370Fatally aborts execution with the given error message. Avoid at all
227costs! The only time this is acceptable is when the terminal process 371costs! The only time this is acceptable is when the terminal process
234that calls this function. 378that calls this function.
235 379
236Using this function has the advantage that its output ends up in the 380Using this function has the advantage that its output ends up in the
237correct place, e.g. on stderr of the connecting urxvtc client. 381correct place, e.g. on stderr of the connecting urxvtc client.
238 382
383=item $is_safe = urxvt::safe
384
385Returns true when it is safe to do potentially unsafe things, such as
386evaluating perl code specified by the user. This is true when urxvt was
387started setuid or setgid.
388
239=item $time = urxvt::NOW 389=item $time = urxvt::NOW
240 390
241Returns the "current time" (as per the event loop). 391Returns the "current time" (as per the event loop).
392
393=item urxvt::CurrentTime
394
395=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
396Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
397Button4Mask, Button5Mask, AnyModifier
398
399Various constants for use in X calls and event processing.
242 400
243=back 401=back
244 402
245=head2 RENDITION 403=head2 RENDITION
246 404
296 454
297=cut 455=cut
298 456
299package urxvt; 457package urxvt;
300 458
459use utf8;
301use strict; 460use strict;
461use Carp ();
302use Scalar::Util (); 462use Scalar::Util ();
463use List::Util ();
303 464
465our $VERSION = 1;
304our $TERM; 466our $TERM;
305our @HOOKNAME; 467our @HOOKNAME;
468our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
469our %OPTION;
470
306our $LIBDIR; 471our $LIBDIR;
472our $RESNAME;
473our $RESCLASS;
474our $RXVTNAME;
307 475
308BEGIN { 476BEGIN {
309 urxvt->bootstrap; 477 urxvt->bootstrap;
310 478
311 # overwrite perl's warn 479 # overwrite perl's warn
313 my $msg = join "", @_; 481 my $msg = join "", @_;
314 $msg .= "\n" 482 $msg .= "\n"
315 unless $msg =~ /\n$/; 483 unless $msg =~ /\n$/;
316 urxvt::warn ($msg); 484 urxvt::warn ($msg);
317 }; 485 };
486
487 delete $ENV{IFS};
488 delete $ENV{CDPATH};
489 delete $ENV{BASH_ENV};
490 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
318} 491}
319 492
320my @hook_count; 493my @hook_count;
321my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 494my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
322 495
323sub verbose { 496sub verbose {
324 my ($level, $msg) = @_; 497 my ($level, $msg) = @_;
325 warn "$msg\n" if $level <= $verbosity; 498 warn "$msg\n" if $level <= $verbosity;
326} 499}
327 500
328# find on_xxx subs in the package and register them 501my $extension_pkg = "extension0000";
329# as hooks 502my %extension_pkg;
330sub register_package($) {
331 my ($pkg) = @_;
332
333 for my $htype (0.. $#HOOKNAME) {
334 my $name = $HOOKNAME[$htype];
335
336 my $ref = $pkg->can ("on_" . lc $name)
337 or next;
338
339 $TERM->{_hook}[$htype]{$pkg} = $ref;
340 $hook_count[$htype]++
341 or set_should_invoke $htype, 1;
342 }
343}
344
345my $script_pkg = "script0000";
346my %script_pkg;
347 503
348# load a single script into its own package, once only 504# load a single script into its own package, once only
349sub script_package($) { 505sub extension_package($) {
350 my ($path) = @_; 506 my ($path) = @_;
351 507
352 $script_pkg{$path} ||= do { 508 $extension_pkg{$path} ||= do {
353 my $pkg = "urxvt::" . ($script_pkg++); 509 my $pkg = "urxvt::" . ($extension_pkg++);
354 510
355 verbose 3, "loading script '$path' into package '$pkg'"; 511 verbose 3, "loading extension '$path' into package '$pkg'";
356 512
357 open my $fh, "<:raw", $path 513 open my $fh, "<:raw", $path
358 or die "$path: $!"; 514 or die "$path: $!";
359 515
516 my $source = untaint
360 my $source = "package $pkg; use strict; use utf8;\n" 517 "package $pkg; use strict; use utf8;\n"
518 . "use base urxvt::term::extension::;\n"
361 . "#line 1 \"$path\"\n{\n" 519 . "#line 1 \"$path\"\n{\n"
362 . (do { local $/; <$fh> }) 520 . (do { local $/; <$fh> })
363 . "\n};\n1"; 521 . "\n};\n1";
364 522
523 eval $source
365 eval $source or die "$path: $@"; 524 or die "$path: $@";
366 525
367 $pkg 526 $pkg
368 } 527 }
369} 528}
529
530our $retval; # return value for urxvt
370 531
371# called by the rxvt core 532# called by the rxvt core
372sub invoke { 533sub invoke {
373 local $TERM = shift; 534 local $TERM = shift;
374 my $htype = shift; 535 my $htype = shift;
375 536
376 if ($htype == 0) { # INIT 537 if ($htype == 0) { # INIT
377 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 538 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
539
540 my %ext_arg;
378 541
379 for my $ext (split /:/, $TERM->resource ("perl_ext")) { 542 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
543 if ($_ eq "default") {
544 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
545 } elsif (/^-(.*)$/) {
546 delete $ext_arg{$1};
547 } elsif (/^([^<]+)<(.*)>$/) {
548 push @{ $ext_arg{$1} }, $2;
549 } else {
550 $ext_arg{$_} ||= [];
551 }
552 }
553
554 while (my ($ext, $argv) = each %ext_arg) {
380 my @files = grep -f $_, map "$_/$ext", @dirs; 555 my @files = grep -f $_, map "$_/$ext", @dirs;
381 556
382 if (@files) { 557 if (@files) {
383 register_package script_package $files[0]; 558 $TERM->register_package (extension_package $files[0], $argv);
384 } else { 559 } else {
385 warn "perl extension '$ext' not found in perl library search path\n"; 560 warn "perl extension '$ext' not found in perl library search path\n";
386 } 561 }
387 } 562 }
388 563
564 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
565 warn $@ if $@;
566 }
567
568 $retval = undef;
569
570 if (my $cb = $TERM->{_hook}[$htype]) {
571 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
572 if $verbosity >= 10;
573
574 keys %$cb;
575
576 while (my ($pkg, $cb) = each %$cb) {
577 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
578 and last;
579
580 if ($@) {
581 $TERM->ungrab; # better to lose the grab than the session
582 warn $@;
583 }
584 }
585 }
586
389 } elsif ($htype == 1) { # DESTROY 587 if ($htype == 1) { # DESTROY
390 if (my $hook = $TERM->{_hook}) { 588 if (my $hook = delete $TERM->{_hook}) {
391 for my $htype (0..$#$hook) { 589 for my $htype (0..$#$hook) {
392 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } 590 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
393 or set_should_invoke $htype, 0; 591 or set_should_invoke $htype, 0;
394 } 592 }
395 } 593 }
594
595 # clear package objects
596 %$_ = () for values %{ $TERM->{_pkg} };
597
598 # clear package
599 %$TERM = ();
396 } 600 }
397 601
398 my $cb = $TERM->{_hook}[$htype] 602 $retval
399 or return; 603}
400 604
401 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 605# urxvt::term::extension
402 if $verbosity >= 10;
403 606
404 keys %$cb; 607package urxvt::term::extension;
405 608
609sub enable {
610 my ($self, %hook) = @_;
611 my $pkg = $self->{_pkg};
612
406 while (my ($pkg, $cb) = each %$cb) { 613 while (my ($name, $cb) = each %hook) {
407 return 1 614 my $htype = $HOOKTYPE{uc $name};
408 if $cb->( 615 defined $htype
409 $TERM->{$pkg} ||= do { 616 or Carp::croak "unsupported hook type '$name'";
410 my $proxy = bless { }, urxvt::term::proxy::; 617
411 Scalar::Util::weaken ($proxy->{term} = $TERM); 618 unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
412 $proxy 619 $hook_count[$htype]++
413 }, 620 or urxvt::set_should_invoke $htype, 1;
414 @_, 621 }
415 ); 622
623 $self->{term}{_hook}[$htype]{$pkg} = $cb;
416 } 624 }
625}
417 626
627sub disable {
628 my ($self, @hook) = @_;
629 my $pkg = $self->{_pkg};
630
631 for my $name (@hook) {
632 my $htype = $HOOKTYPE{uc $name};
633 defined $htype
634 or Carp::croak "unsupported hook type '$name'";
635
636 if (delete $self->{term}{_hook}[$htype]{$pkg}) {
637 --$hook_count[$htype]
638 or urxvt::set_should_invoke $htype, 0;
639 }
418 0 640 }
419} 641}
420 642
421sub urxvt::term::proxy::AUTOLOAD { 643our $AUTOLOAD;
422 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 644
645sub AUTOLOAD {
646 $AUTOLOAD =~ /:([^:]+)$/
423 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 647 or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
424 648
425 eval qq{ 649 eval qq{
426 sub $urxvt::term::proxy::AUTOLOAD { 650 sub $AUTOLOAD {
427 my \$proxy = shift; 651 my \$proxy = shift;
428 \$proxy->{term}->$1 (\@_) 652 \$proxy->{term}->$1 (\@_)
429 } 653 }
430 1 654 1
431 } or die "FATAL: unable to compile method forwarder: $@"; 655 } or die "FATAL: unable to compile method forwarder: $@";
432 656
433 goto &$urxvt::term::proxy::AUTOLOAD; 657 goto &$AUTOLOAD;
434} 658}
659
660sub DESTROY {
661 # nop
662}
663
664# urxvt::destroy_hook
665
666sub urxvt::destroy_hook::DESTROY {
667 ${$_[0]}->();
668}
669
670sub urxvt::destroy_hook(&) {
671 bless \shift, urxvt::destroy_hook::
672}
673
674package urxvt::anyevent;
675
676=head2 The C<urxvt::anyevent> Class
677
678The sole purpose of this class is to deliver an interface to the
679C<AnyEvent> module - any module using it will work inside urxvt without
680further work. The only exception is that you cannot wait on condition
681variables, but non-blocking condvar use is ok. What this means is that you
682cannot use blocking APIs, but the non-blocking variant should work.
683
684=cut
685
686our $VERSION = 1;
687
688$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
689push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
690
691sub timer {
692 my ($class, %arg) = @_;
693
694 my $cb = $arg{cb};
695
696 urxvt::timer
697 ->new
698 ->start (urxvt::NOW + $arg{after})
699 ->cb (sub {
700 $_[0]->stop; # need to cancel manually
701 $cb->();
702 })
703}
704
705sub io {
706 my ($class, %arg) = @_;
707
708 my $cb = $arg{cb};
709
710 bless [$arg{fh}, urxvt::iow
711 ->new
712 ->fd (fileno $arg{fh})
713 ->events (($arg{poll} =~ /r/ ? 1 : 0)
714 | ($arg{poll} =~ /w/ ? 2 : 0))
715 ->start
716 ->cb (sub {
717 $cb->(($_[1] & 1 ? 'r' : '')
718 . ($_[1] & 2 ? 'w' : ''));
719 })],
720 urxvt::anyevent::
721}
722
723sub DESTROY {
724 $_[0][1]->stop;
725}
726
727sub condvar {
728 bless \my $flag, urxvt::anyevent::condvar::
729}
730
731sub urxvt::anyevent::condvar::broadcast {
732 ${$_[0]}++;
733}
734
735sub urxvt::anyevent::condvar::wait {
736 unless (${$_[0]}) {
737 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
738 }
739}
740
741package urxvt::term;
435 742
436=head2 The C<urxvt::term> Class 743=head2 The C<urxvt::term> Class
437 744
438=over 4 745=over 4
746
747=cut
748
749# find on_xxx subs in the package and register them
750# as hooks
751sub register_package {
752 my ($self, $pkg, $argv) = @_;
753
754 my $proxy = bless {
755 _pkg => $pkg,
756 argv => $argv,
757 }, $pkg;
758 Scalar::Util::weaken ($proxy->{term} = $self);
759
760 $self->{_pkg}{$pkg} = $proxy;
761
762 for my $name (@HOOKNAME) {
763 if (my $ref = $pkg->can ("on_" . lc $name)) {
764 $proxy->enable ($name => $ref);
765 }
766 }
767}
768
769=item $term->destroy
770
771Destroy the terminal object (close the window, free resources etc.).
772
773=item $isset = $term->option ($optval[, $set])
774
775Returns true if the option specified by C<$optval> is enabled, and
776optionally change it. All option values are stored by name in the hash
777C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
778
779Here is a a likely non-exhaustive list of option names, please see the
780source file F</src/optinc.h> to see the actual list:
781
782 borderLess console cursorBlink cursorUnderline hold iconic insecure
783 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
784 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
785 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
786 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
787 tripleclickwords utmpInhibit visualBell
439 788
440=item $value = $term->resource ($name[, $newval]) 789=item $value = $term->resource ($name[, $newval])
441 790
442Returns the current resource value associated with a given name and 791Returns the current resource value associated with a given name and
443optionally sets a new value. Setting values is most useful in the C<init> 792optionally sets a new value. Setting values is most useful in the C<init>
453 802
454Please note that resource strings will currently only be freed when the 803Please note that resource strings will currently only be freed when the
455terminal is destroyed, so changing options frequently will eat memory. 804terminal is destroyed, so changing options frequently will eat memory.
456 805
457Here is a a likely non-exhaustive list of resource names, not all of which 806Here is a a likely non-exhaustive list of resource names, not all of which
458are supported in every build, please see the source to see the actual 807are supported in every build, please see the source file F</src/rsinc.h>
459list: 808to see the actual list:
460 809
461 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 810 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
462 borderLess color cursorBlink cursorUnderline cutchars delete_key 811 borderLess color cursorBlink cursorUnderline cutchars delete_key
463 display_name embed ext_bwidth fade font geometry hold iconName 812 display_name embed ext_bwidth fade font geometry hold iconName
464 imFont imLocale inputMethod insecure int_bwidth intensityStyles 813 imFont imLocale inputMethod insecure int_bwidth intensityStyles
465 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 814 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
466 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext 815 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
467 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 816 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
468 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 817 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
469 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 818 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
470 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 819 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
471 shade term_name title transparent transparent_all tripleclickwords 820 shade term_name title transparent transparent_all tripleclickwords
472 utmpInhibit visualBell 821 utmpInhibit visualBell
473 822
474=cut 823=cut
475 824
476sub urxvt::term::resource($$;$) { 825sub resource($$;$) {
477 my ($self, $name) = (shift, shift); 826 my ($self, $name) = (shift, shift);
478 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 827 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
479 goto &urxvt::term::_resource; 828 &urxvt::term::_resource
480} 829}
830
831=item $success = $term->parse_keysym ($keysym_spec, $command_string)
832
833Adds a keymap translation exactly as specified via a resource. See the
834C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
835
836=item $rend = $term->rstyle ([$new_rstyle])
837
838Return and optionally change the current rendition. Text that is output by
839the terminal application will use this style.
840
841=item ($row, $col) = $term->screen_cur ([$row, $col])
842
843Return the current coordinates of the text cursor position and optionally
844set it (which is usually bad as applications don't expect that).
481 845
482=item ($row, $col) = $term->selection_mark ([$row, $col]) 846=item ($row, $col) = $term->selection_mark ([$row, $col])
483 847
484=item ($row, $col) = $term->selection_beg ([$row, $col]) 848=item ($row, $col) = $term->selection_beg ([$row, $col])
485 849
495 859
496=item $oldtext = $term->selection ([$newtext]) 860=item $oldtext = $term->selection ([$newtext])
497 861
498Return the current selection text and optionally replace it by C<$newtext>. 862Return the current selection text and optionally replace it by C<$newtext>.
499 863
500#=item $term->overlay ($x, $y, $text) 864=item $term->overlay_simple ($x, $y, $text)
501# 865
502#Create a simple multi-line overlay box. See the next method for details. 866Create a simple multi-line overlay box. See the next method for details.
503# 867
504#=cut 868=cut
505 869
506sub urxvt::term::scr_overlay { 870sub overlay_simple {
507die;
508 my ($self, $x, $y, $text) = @_; 871 my ($self, $x, $y, $text) = @_;
509 872
510 my @lines = split /\n/, $text; 873 my @lines = split /\n/, $text;
511 874
512 my $w = 0; 875 my $w = List::Util::max map $self->strwidth ($_), @lines;
513 for (map $self->strwidth ($_), @lines) {
514 $w = $_ if $w < $_;
515 }
516 876
517 $self->scr_overlay_new ($x, $y, $w, scalar @lines); 877 my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
518 $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; 878 $overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
879
880 $overlay
519} 881}
520 882
521=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) 883=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
522 884
523Create a new (empty) overlay at the given position with the given 885Create a new (empty) overlay at the given position with the given
551 913
552If hidden, display the overlay again. 914If hidden, display the overlay again.
553 915
554=back 916=back
555 917
918=item $popup = $term->popup ($event)
919
920Creates a new C<urxvt::popup> object that implements a popup menu. The
921C<$event> I<must> be the event causing the menu to pop up (a button event,
922currently).
923
924=cut
925
926sub popup {
927 my ($self, $event) = @_;
928
929 $self->grab ($event->{time}, 1)
930 or return;
931
932 my $popup = bless {
933 term => $self,
934 event => $event,
935 }, urxvt::popup::;
936
937 Scalar::Util::weaken $popup->{term};
938
939 $self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
940 Scalar::Util::weaken $self->{_destroy}{$popup};
941
942 $popup
943}
944
556=item $cellwidth = $term->strwidth $string 945=item $cellwidth = $term->strwidth ($string)
557 946
558Returns the number of screen-cells this string would need. Correctly 947Returns the number of screen-cells this string would need. Correctly
559accounts for wide and combining characters. 948accounts for wide and combining characters.
560 949
561=item $octets = $term->locale_encode $string 950=item $octets = $term->locale_encode ($string)
562 951
563Convert the given text string into the corresponding locale encoding. 952Convert the given text string into the corresponding locale encoding.
564 953
565=item $string = $term->locale_decode $octets 954=item $string = $term->locale_decode ($octets)
566 955
567Convert the given locale-encoded octets into a perl string. 956Convert the given locale-encoded octets into a perl string.
957
958=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
959
960XORs the rendition values in the given span with the provided value
961(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
962to the selection.
963
964=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
965
966Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
967whitespace will additionally be xored with the C<$rstyle2>, which defaults
968to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
969it instead.
970
971=item $term->scr_bell
972
973Ring the bell!
974
975=item $term->scr_add_lines ($string)
976
977Write the given text string to the screen, as if output by the application
978running inside the terminal. It may not contain command sequences (escape
979codes), but is free to use line feeds, carriage returns and tabs. The
980string is a normal text string, not in locale-dependent encoding.
981
982Normally its not a good idea to use this function, as programs might be
983confused by changes in cursor position or scrolling. Its useful inside a
984C<on_add_lines> hook, though.
985
986=item $term->cmd_parse ($octets)
987
988Similar to C<scr_add_lines>, but the argument must be in the
989locale-specific encoding of the terminal and can contain command sequences
990(escape codes) that will be interpreted.
568 991
569=item $term->tt_write ($octets) 992=item $term->tt_write ($octets)
570 993
571Write the octets given in C<$data> to the tty (i.e. as program input). To 994Write the octets given in C<$data> to the tty (i.e. as program input). To
572pass characters instead of octets, you should convert your strings first 995pass characters instead of octets, you should convert your strings first
573to the locale-specific encoding using C<< $term->locale_encode >>. 996to the locale-specific encoding using C<< $term->locale_encode >>.
574 997
998=item $old_events = $term->pty_ev_events ([$new_events])
999
1000Replaces the event mask of the pty watcher by the given event mask. Can
1001be used to suppress input and output handling to the pty/tty. See the
1002description of C<< urxvt::timer->events >>. Make sure to always restore
1003the previous value.
1004
1005=item $windowid = $term->parent
1006
1007Return the window id of the toplevel window.
1008
1009=item $windowid = $term->vt
1010
1011Return the window id of the terminal window.
1012
1013=item $window_width = $term->width
1014
1015=item $window_height = $term->height
1016
1017=item $font_width = $term->fwidth
1018
1019=item $font_height = $term->fheight
1020
1021=item $font_ascent = $term->fbase
1022
575=item $nrow = $term->nrow 1023=item $terminal_rows = $term->nrow
576 1024
577=item $ncol = $term->ncol 1025=item $terminal_columns = $term->ncol
578 1026
579Return the number of rows/columns of the terminal window (i.e. as 1027=item $has_focus = $term->focus
580specified by C<-geometry>, excluding any scrollback).
581 1028
582=item $nsaved = $term->nsaved 1029=item $is_mapped = $term->mapped
583 1030
584Returns the number of lines in the scrollback buffer. 1031=item $max_scrollback = $term->saveLines
1032
1033=item $nrow_plus_saveLines = $term->total_rows
1034
1035=item $lines_in_scrollback = $term->nsaved
1036
1037Return various integers describing terminal characteristics.
1038
1039=item $lc_ctype = $term->locale
1040
1041Returns the LC_CTYPE category string used by this rxvt-unicode.
1042
1043=item $x_display = $term->display_id
1044
1045Return the DISPLAY used by rxvt-unicode.
1046
1047=item $modifiermask = $term->ModLevel3Mask
1048
1049=item $modifiermask = $term->ModMetaMask
1050
1051=item $modifiermask = $term->ModNumLockMask
1052
1053Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1054AltGr), the meta key (often Alt) and the num lock key, if applicable.
585 1055
586=item $view_start = $term->view_start ([$newvalue]) 1056=item $view_start = $term->view_start ([$newvalue])
587 1057
588Returns the negative row number of the topmost line. Minimum value is 1058Returns the negative row number of the topmost line. Minimum value is
589C<0>, which displays the normal terminal contents. Larger values scroll 1059C<0>, which displays the normal terminal contents. Larger values scroll
652about the logical line that row C<$row_number> is part of. It supports the 1122about the logical line that row C<$row_number> is part of. It supports the
653following methods: 1123following methods:
654 1124
655=over 4 1125=over 4
656 1126
657=item $text = $line->t 1127=item $text = $line->t ([$new_text])
658 1128
659Returns the full text of the line, similar to C<ROW_t> 1129Returns or replaces the full text of the line, similar to C<ROW_t>
660 1130
661=item $rend = $line->r 1131=item $rend = $line->r ([$new_rend])
662 1132
663Returns the full rendition array of the line, similar to C<ROW_r> 1133Returns or replaces the full rendition array of the line, similar to C<ROW_r>
664 1134
665=item $length = $line->l 1135=item $length = $line->l
666 1136
667Returns the length of the line in cells, similar to C<ROW_l>. 1137Returns the length of the line in cells, similar to C<ROW_l>.
668 1138
683 1153
684=back 1154=back
685 1155
686=cut 1156=cut
687 1157
688sub urxvt::term::line { 1158sub line {
689 my ($self, $row) = @_; 1159 my ($self, $row) = @_;
690 1160
691 my $maxrow = $self->nrow - 1; 1161 my $maxrow = $self->nrow - 1;
692 1162
693 my ($beg, $end) = ($row, $row); 1163 my ($beg, $end) = ($row, $row);
697 1167
698 bless { 1168 bless {
699 term => $self, 1169 term => $self,
700 beg => $beg, 1170 beg => $beg,
701 end => $end, 1171 end => $end,
1172 ncol => $self->ncol,
702 len => ($end - $beg) * $self->ncol + $self->ROW_l ($end), 1173 len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
703 }, urxvt::line:: 1174 }, urxvt::line::
704} 1175}
705 1176
706sub urxvt::line::t { 1177sub urxvt::line::t {
707 my ($self) = @_; 1178 my ($self) = @_;
708 1179
1180 if (@_ > 1)
1181 {
1182 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1183 for $self->{beg} .. $self->{end};
1184 }
1185
1186 defined wantarray &&
709 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), 1187 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
710 0, $self->{len} 1188 0, $self->{len}
711} 1189}
712 1190
713sub urxvt::line::r { 1191sub urxvt::line::r {
714 my ($self) = @_; 1192 my ($self) = @_;
715 1193
1194 if (@_ > 1)
1195 {
1196 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1197 for $self->{beg} .. $self->{end};
1198 }
1199
1200 if (defined wantarray) {
716 my $rend = [ 1201 my $rend = [
717 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} 1202 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
718 ]; 1203 ];
719 $#$rend = $self->{len} - 1; 1204 $#$rend = $self->{len} - 1;
720 $rend 1205 return $rend;
1206 }
1207
1208 ()
721} 1209}
722 1210
723sub urxvt::line::beg { $_[0]{beg} } 1211sub urxvt::line::beg { $_[0]{beg} }
724sub urxvt::line::end { $_[0]{end} } 1212sub urxvt::line::end { $_[0]{end} }
725sub urxvt::line::l { $_[0]{len} } 1213sub urxvt::line::l { $_[0]{len} }
726 1214
727sub urxvt::line::offset_of { 1215sub urxvt::line::offset_of {
728 my ($self, $row, $col) = @_; 1216 my ($self, $row, $col) = @_;
729 1217
730 ($row - $self->{beg}) * $self->{term}->ncol + $col 1218 ($row - $self->{beg}) * $self->{ncol} + $col
731} 1219}
732 1220
733sub urxvt::line::coord_of { 1221sub urxvt::line::coord_of {
734 my ($self, $offset) = @_; 1222 my ($self, $offset) = @_;
735 1223
736 use integer; 1224 use integer;
737 1225
738 ( 1226 (
739 $offset / $self->{term}->ncol + $self->{beg}, 1227 $offset / $self->{ncol} + $self->{beg},
740 $offset % $self->{term}->ncol 1228 $offset % $self->{ncol}
741 ) 1229 )
742} 1230}
743 1231
744=item ($row, $col) = $line->coord_of ($offset)
745=item $text = $term->special_encode $string 1232=item $text = $term->special_encode $string
746 1233
747Converts a perl string into the special encoding used by rxvt-unicode, 1234Converts a perl string into the special encoding used by rxvt-unicode,
748where one character corresponds to one screen cell. See 1235where one character corresponds to one screen cell. See
749C<< $term->ROW_t >> for details. 1236C<< $term->ROW_t >> for details.
751=item $string = $term->special_decode $text 1238=item $string = $term->special_decode $text
752 1239
753Converts rxvt-unicodes text reprsentation into a perl string. See 1240Converts rxvt-unicodes text reprsentation into a perl string. See
754C<< $term->ROW_t >> for details. 1241C<< $term->ROW_t >> for details.
755 1242
1243=item $success = $term->grab_button ($button, $modifiermask)
1244
1245Registers a synchronous button grab. See the XGrabButton manpage.
1246
1247=item $success = $term->grab ($eventtime[, $sync])
1248
1249Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1250synchronous (C<$sync> is true). Also remembers the grab timestampe.
1251
1252=item $term->allow_events_async
1253
1254Calls XAllowEvents with AsyncBoth for the most recent grab.
1255
1256=item $term->allow_events_sync
1257
1258Calls XAllowEvents with SyncBoth for the most recent grab.
1259
1260=item $term->allow_events_replay
1261
1262Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1263recent grab.
1264
1265=item $term->ungrab
1266
1267Calls XUngrab for the most recent grab. Is called automatically on
1268evaluation errors, as it is better to lose the grab in the error case as
1269the session.
1270
756=back 1271=back
1272
1273=cut
1274
1275package urxvt::popup;
1276
1277=head2 The C<urxvt::popup> Class
1278
1279=over 4
1280
1281=cut
1282
1283sub add_item {
1284 my ($self, $item) = @_;
1285
1286 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
1287 $item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
1288 $item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
1289
1290 $item->{render} ||= sub { $_[0]{text} };
1291
1292 push @{ $self->{item} }, $item;
1293}
1294
1295sub add_separator {
1296 my ($self, $sep) = @_;
1297
1298 $sep ||= "=";
1299
1300 $self->add_item ({
1301 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1302 text => "",
1303 render => sub { $sep x $self->{term}->ncol },
1304 activate => sub { },
1305 });
1306}
1307
1308sub add_title {
1309 my ($self, $title) = @_;
1310
1311 $self->add_item ({
1312 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
1313 text => $title,
1314 activate => sub { },
1315 });
1316}
1317
1318sub add_button {
1319 my ($self, $text, $cb) = @_;
1320
1321 $self->add_item ({ type => "button", text => $text, activate => $cb});
1322}
1323
1324sub add_toggle {
1325 my ($self, $text, $cb, $value) = @_;
1326
1327 my $item; $item = {
1328 type => "button",
1329 text => " $text",
1330 value => $value,
1331 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1332 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
1333 };
1334
1335 $self->add_item ($item);
1336}
1337
1338sub show {
1339 my ($self) = @_;
1340
1341 local $urxvt::popup::self = $self;
1342
1343 local $ENV{LC_ALL} = $self->{term}->locale;
1344
1345 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1346 "--transient-for" => $self->{term}->parent,
1347 "-display" => $self->{term}->display_id,
1348 "-pe" => "urxvt-popup")
1349 or die "unable to create popup window\n";
1350}
1351
1352sub DESTROY {
1353 my ($self) = @_;
1354
1355 delete $self->{term}{_destroy}{$self};
1356 $self->{term}->ungrab;
1357}
757 1358
758=head2 The C<urxvt::timer> Class 1359=head2 The C<urxvt::timer> Class
759 1360
760This class implements timer watchers/events. Time is represented as a 1361This class implements timer watchers/events. Time is represented as a
761fractional number of seconds since the epoch. Example: 1362fractional number of seconds since the epoch. Example:
814 1415
815 $term->{socket} = ... 1416 $term->{socket} = ...
816 $term->{iow} = urxvt::iow 1417 $term->{iow} = urxvt::iow
817 ->new 1418 ->new
818 ->fd (fileno $term->{socket}) 1419 ->fd (fileno $term->{socket})
819 ->events (1) # wait for read data 1420 ->events (urxvt::EVENT_READ)
820 ->start 1421 ->start
821 ->cb (sub { 1422 ->cb (sub {
822 my ($iow, $revents) = @_; 1423 my ($iow, $revents) = @_;
823 # $revents must be 1 here, no need to check 1424 # $revents must be 1 here, no need to check
824 sysread $term->{socket}, my $buf, 8192 1425 sysread $term->{socket}, my $buf, 8192
841 1442
842Set the filedescriptor (not handle) to watch. 1443Set the filedescriptor (not handle) to watch.
843 1444
844=item $iow = $iow->events ($eventmask) 1445=item $iow = $iow->events ($eventmask)
845 1446
846Set the event mask to watch. Bit #0 (value C<1>) enables watching for read 1447Set the event mask to watch. The only allowed values are
847data, Bit #1 (value C<2>) enables watching for write data. 1448C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
1449together, or C<urxvt::EVENT_NONE>.
848 1450
849=item $iow = $iow->start 1451=item $iow = $iow->start
850 1452
851Start watching for requested events on the given handle. 1453Start watching for requested events on the given handle.
852 1454
863This variable controls the verbosity level of the perl extension. Higher 1465This variable controls the verbosity level of the perl extension. Higher
864numbers indicate more verbose output. 1466numbers indicate more verbose output.
865 1467
866=over 4 1468=over 4
867 1469
868=item =0 - only fatal messages 1470=item == 0 - fatal messages
869 1471
870=item =3 - script loading and management 1472=item >= 3 - script loading and management
871 1473
872=item =10 - all events received 1474=item >=10 - all events received
873 1475
874=back 1476=back
875 1477
876=head1 AUTHOR 1478=head1 AUTHOR
877 1479

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines