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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines