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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines