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.18 by root, Tue Jan 3 02:01:27 2006 UTC vs.
Revision 1.59 by root, Mon Jan 9 00:34:36 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
44Miscellaneous selection modifications. 44Intelligent selection. This extension tries to be more intelligent when
45the user extends selections (double-click). Right now, it tries to select
46urls and complete shell-quoted arguments, which is very convenient, too,
47if your F<ls> supports C<--quoting-style=shell>.
48
49It also offers the following bindable event:
45 50
46=over 4 51=over 4
47 52
48=item rot13 53=item rot13
49 54
51 56
52 URxvt.keysym.C-M-r: perl:selection:rot13 57 URxvt.keysym.C-M-r: perl:selection:rot13
53 58
54=back 59=back
55 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
56=item digital-clock 71=item digital-clock
72
73Displays a digital clock using the built-in overlay.
74
75=item mark-urls
76
77Uses per-line display filtering (C<on_line_update>) to underline urls.
78
79=item block-graphics-to-ascii
80
81A not very useful example of filtering all text output to the terminal,
82by replacing all line-drawing characters (U+2500 .. U+259F) by a
83similar-looking ascii character.
84
85=item example-refresh-hooks
57 86
58Displays a very simple digital clock in the upper right corner of the 87Displays a very simple digital clock in the upper right corner of the
59window. Illustrates overwriting the refresh callbacks to create your own 88window. Illustrates overwriting the refresh callbacks to create your own
60overlays or changes. 89overlays or changes.
61 90
62=item simple-overlay-clock
63
64Displays a digital clock using the built-in overlay (colourful, useless).
65
66=back 91=back
67 92
68=head2 General API Considerations 93=head2 General API Considerations
69 94
70All objects (such as terminals, time watchers etc.) are typical 95All objects (such as terminals, time watchers etc.) are typical
71reference-to-hash objects. The hash can be used to store anything you 96reference-to-hash objects. The hash can be used to store anything you
72like. All members starting with an underscore (such as C<_ptr> or 97like. All members starting with an underscore (such as C<_ptr> or
73C<_hook>) are reserved for internal uses and must not be accessed or 98C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
74modified). 99modified).
75 100
76When objects are destroyed on the C++ side, the perl object hashes are 101When objects are destroyed on the C++ side, the perl object hashes are
77emptied, so its best to store related objects such as time watchers and 102emptied, so its best to store related objects such as time watchers and
78the like inside the terminal object so they get destroyed as soon as the 103the like inside the terminal object so they get destroyed as soon as the
79terminal is destroyed. 104terminal is destroyed.
80 105
106Argument names also often indicate the type of a parameter. Here are some
107hints on what they mean:
108
109=over 4
110
111=item $text
112
113Rxvt-unicodes special way of encoding text, where one "unicode" character
114always represents one screen cell. See L<row_t> for a discussion of this format.
115
116=item $string
117
118A perl text string, with an emphasis on I<text>. It can store all unicode
119characters and is to be distinguished with text encoded in a specific
120encoding (often locale-specific) and binary data.
121
122=item $octets
123
124Either binary data or - more common - a text string encoded in a
125locale-specific way.
126
127=back
128
81=head2 Hooks 129=head2 Hooks
82 130
83The following subroutines can be declared in loaded scripts, and will be called 131The following subroutines can be declared in extension files, and will be
84whenever the relevant event happens. 132called whenever the relevant event happens.
133
134The first argument passed to them is an object private to each terminal
135and extension package. You can call all C<urxvt::term> methods on it, but
136its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
137object that is shared between all packages is stored in the C<term>
138member. It is, however, blessed intot he package of the extension script,
139so for all practical purposes you can treat an extension script as a class.
85 140
86All of them must return a boolean value. If it is true, then the event 141All of them must return a boolean value. If it is true, then the event
87counts as being I<consumed>, and the invocation of other hooks is skipped, 142counts as being I<consumed>, and the invocation of other hooks is skipped,
88and the relevant action might not be carried out by the C++ code. 143and the relevant action might not be carried out by the C++ code.
89 144
92=over 4 147=over 4
93 148
94=item on_init $term 149=item on_init $term
95 150
96Called after a new terminal object has been initialized, but before 151Called after a new terminal object has been initialized, but before
97windows are created or the command gets run. 152windows are created or the command gets run. Most methods are unsafe to
153call or deliver senseless data, as terminal size and other characteristics
154have not yet been determined. You can safely query and change resources,
155though.
98 156
99=item on_reset $term 157=item on_reset $term
100 158
101Called after the screen is "reset" for any reason, such as resizing or 159Called after the screen is "reset" for any reason, such as resizing or
102control sequences. Here is where you can react on changes to size-related 160control sequences. Here is where you can react on changes to size-related
122requested from the server. The selection text can be queried and changed 180requested from the server. The selection text can be queried and changed
123by calling C<< $term->selection >>. 181by calling C<< $term->selection >>.
124 182
125Returning a true value aborts selection grabbing. It will still be hilighted. 183Returning a true value aborts selection grabbing. It will still be hilighted.
126 184
127=item on_focus_in $term 185=item on_sel_extend $term
128 186
129Called whenever the window gets the keyboard focus, before urxvt does 187Called whenever the user tries to extend the selection (e.g. with a double
130focus in processing. 188click) and is either supposed to return false (normal operation), or
131 189should extend the selection itelf and return true to suppress the built-in
132=item on_focus_out $term
133
134Called wheneever the window loses keyboard focus, before urxvt does focus
135out processing. 190processing.
191
192See the F<selection> example extension.
136 193
137=item on_view_change $term, $offset 194=item on_view_change $term, $offset
138 195
139Called whenever the view offset changes, i..e the user or program 196Called whenever the view offset changes, i..e the user or program
140scrolls. Offset C<0> means display the normal terminal, positive values 197scrolls. Offset C<0> means display the normal terminal, positive values
151number of lines that will be in the scrollback buffer. 208number of lines that will be in the scrollback buffer.
152 209
153=item on_tty_activity $term *NYI* 210=item on_tty_activity $term *NYI*
154 211
155Called whenever the program(s) running in the urxvt window send output. 212Called whenever the program(s) running in the urxvt window send output.
213
214=item on_osc_seq $term, $string
215
216Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
217operating system command) is processed. Cursor position and other state
218information is up-to-date when this happens. For interoperability, the
219string should start with the extension name and a colon, to distinguish
220it from commands for other extensions, and this might be enforced in the
221future.
222
223Be careful not ever to trust (in a security sense) the data you receive,
224as its source can not easily be controleld (e-mail content, messages from
225other users on the same system etc.).
226
227=item on_add_lines $term, $string
228
229Called whenever text is about to be output, with the text as argument. You
230can filter/change and output the text yourself by returning a true value
231and calling C<< $term->scr_add_lines >> yourself. Please note that this
232might be very slow, however, as your hook is called for B<all> text being
233output.
234
235=item on_line_update $term, $row
236
237Called whenever a line was updated or changed. Can be used to filter
238screen output (e.g. underline urls or other useless stuff). Only lines
239that are being shown will be filtered, and, due to performance reasons,
240not always immediately.
241
242The row number is always the topmost row of the line if the line spans
243multiple rows.
244
245Please note that, if you change the line, then the hook might get called
246later with the already-modified line (e.g. if unrelated parts change), so
247you cannot just toggle rendition bits, but only set them.
156 248
157=item on_refresh_begin $term 249=item on_refresh_begin $term
158 250
159Called just before the screen gets redrawn. Can be used for overlay 251Called just before the screen gets redrawn. Can be used for overlay
160or similar effects by modify terminal contents in refresh_begin, and 252or similar effects by modify terminal contents in refresh_begin, and
169 261
170Called whenever the user presses a key combination that has a 262Called whenever the user presses a key combination that has a
171C<perl:string> action bound to it (see description of the B<keysym> 263C<perl:string> action bound to it (see description of the B<keysym>
172resource in the @@RXVT_NAME@@(1) manpage). 264resource in the @@RXVT_NAME@@(1) manpage).
173 265
266=item on_focus_in $term
267
268Called whenever the window gets the keyboard focus, before rxvt-unicode
269does focus in processing.
270
271=item on_focus_out $term
272
273Called wheneever the window loses keyboard focus, before rxvt-unicode does
274focus out processing.
275
276=item on_key_press $term, $event, $octets
277
278=item on_key_release $term, $event
279
280=item on_button_press $term, $event
281
282=item on_button_release $term, $event
283
284=item on_motion_notify $term, $event
285
286=item on_map_notify $term, $event
287
288=item on_unmap_notify $term, $event
289
290Called whenever the corresponding X event is received for the terminal If
291the hook returns true, then the even will be ignored by rxvt-unicode.
292
293The event is a hash with most values as named by Xlib (see the XEvent
294manpage), with the additional members C<row> and C<col>, which are the row
295and column under the mouse cursor.
296
297C<on_key_press> additionally receives the string rxvt-unicode would
298output, if any, in locale-specific encoding.
299
300subwindow.
301
174=back 302=back
175 303
304=head2 Variables in the C<urxvt> Package
305
306=over 4
307
308=item $urxvt::TERM
309
310The current terminal. This variable stores the current C<urxvt::term>
311object, whenever a callback/hook is executing.
312
313=back
314
176=head2 Functions in the C<urxvt> Package 315=head2 Functions in the C<urxvt> Package
177 316
178=over 4 317=over 4
318
319=item $term = new urxvt [arg...]
320
321Creates a new terminal, very similar as if you had started it with
322C<system $binfile, arg...>. Croaks (and probably outputs an error message)
323if the new instance couldn't be created. Returns C<undef> if the new
324instance didn't initialise perl, and the terminal object otherwise. The
325C<init> and C<start> hooks will be called during the call.
179 326
180=item urxvt::fatal $errormessage 327=item urxvt::fatal $errormessage
181 328
182Fatally aborts execution with the given error message. Avoid at all 329Fatally aborts execution with the given error message. Avoid at all
183costs! The only time this is acceptable is when the terminal process 330costs! The only time this is acceptable is when the terminal process
193correct place, e.g. on stderr of the connecting urxvtc client. 340correct place, e.g. on stderr of the connecting urxvtc client.
194 341
195=item $time = urxvt::NOW 342=item $time = urxvt::NOW
196 343
197Returns the "current time" (as per the event loop). 344Returns the "current time" (as per the event loop).
345
346=item urxvt::CurrentTime
347
348=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
349Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
350Button4Mask, Button5Mask, AnyModifier
351
352Various constants for use in X calls and event processing.
353
354=back
198 355
199=head2 RENDITION 356=head2 RENDITION
200 357
201Rendition bitsets contain information about colour, font, font styles and 358Rendition bitsets contain information about colour, font, font styles and
202similar information for each screen cell. 359similar information for each screen cell.
218Return the rendition mask used for overlays by default. 375Return the rendition mask used for overlays by default.
219 376
220=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline 377=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
221 378
222Return the bit that enabled bold, italic, blink, reverse-video and 379Return the bit that enabled bold, italic, blink, reverse-video and
223underline, respectively. To enable such a style, just or it onto the 380underline, respectively. To enable such a style, just logically OR it into
224bitset. 381the bitset.
225 382
226=item $foreground = urxvt::GET_BASEFG $rend 383=item $foreground = urxvt::GET_BASEFG $rend
227 384
228=item $background = urxvt::GET_BASEBG $rend 385=item $background = urxvt::GET_BASEBG $rend
229 386
234=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) 391=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
235 392
236Replace the foreground/background colour in the rendition mask with the 393Replace the foreground/background colour in the rendition mask with the
237specified one. 394specified one.
238 395
396=item $value = urxvt::GET_CUSTOM ($rend)
397
398Return the "custom" value: Every rendition has 5 bits for use by
399extensions. They can be set and changed as you like and are initially
400zero.
401
402=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
403
404Change the custom value.
405
239=back 406=back
240 407
241=cut 408=cut
242 409
243package urxvt; 410package urxvt;
244 411
412use utf8;
245use strict; 413use strict;
414use Scalar::Util ();
415use List::Util ();
246 416
247our $term; 417our $VERSION = 1;
418our $TERM;
248our @HOOKNAME; 419our @HOOKNAME;
420our %OPTION;
249our $LIBDIR; 421our $LIBDIR;
250 422
251BEGIN { 423BEGIN {
252 urxvt->bootstrap; 424 urxvt->bootstrap;
253 425
256 my $msg = join "", @_; 428 my $msg = join "", @_;
257 $msg .= "\n" 429 $msg .= "\n"
258 unless $msg =~ /\n$/; 430 unless $msg =~ /\n$/;
259 urxvt::warn ($msg); 431 urxvt::warn ($msg);
260 }; 432 };
433
434 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
435 delete $ENV{CDPATH};
261} 436}
262 437
263my @hook_count; 438my @hook_count;
264my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 439my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
265 440
277 my $name = $HOOKNAME[$htype]; 452 my $name = $HOOKNAME[$htype];
278 453
279 my $ref = $pkg->can ("on_" . lc $name) 454 my $ref = $pkg->can ("on_" . lc $name)
280 or next; 455 or next;
281 456
282 $term->{_hook}[$htype]{$ref*1} = $ref; 457 $TERM->{_hook}[$htype]{$pkg} = $ref;
283 $hook_count[$htype]++ 458 $hook_count[$htype]++
284 or set_should_invoke $htype, 1; 459 or set_should_invoke $htype, 1;
285 } 460 }
286} 461}
287 462
288my $script_pkg = "script0000"; 463my $extension_pkg = "extension0000";
289my %script_pkg; 464my %extension_pkg;
290 465
291# load a single script into its own package, once only 466# load a single script into its own package, once only
292sub script_package($) { 467sub extension_package($) {
293 my ($path) = @_; 468 my ($path) = @_;
294 469
295 $script_pkg{$path} ||= do { 470 $extension_pkg{$path} ||= do {
296 my $pkg = "urxvt::" . ($script_pkg++); 471 my $pkg = "urxvt::" . ($extension_pkg++);
297 472
298 verbose 3, "loading script '$path' into package '$pkg'"; 473 verbose 3, "loading extension '$path' into package '$pkg'";
299 474
300 open my $fh, "<:raw", $path 475 open my $fh, "<:raw", $path
301 or die "$path: $!"; 476 or die "$path: $!";
302 477
303 my $source = "package $pkg; use strict; use utf8;\n" 478 my $source = untaint "package $pkg; use strict; use utf8;\n"
479 . "use base urxvt::term::proxy::;\n"
304 . "#line 1 \"$path\"\n{\n" 480 . "#line 1 \"$path\"\n{\n"
305 . (do { local $/; <$fh> }) 481 . (do { local $/; <$fh> })
306 . "\n};\n1"; 482 . "\n};\n1";
307 483
308 eval $source or die "$path: $@"; 484 eval $source or die "$path: $@";
309 485
310 $pkg 486 $pkg
311 } 487 }
312} 488}
313 489
490our $retval; # return value for urxvt
491
314# called by the rxvt core 492# called by the rxvt core
315sub invoke { 493sub invoke {
316 local $term = shift; 494 local $TERM = shift;
317 my $htype = shift; 495 my $htype = shift;
318 496
319 if ($htype == 0) { # INIT 497 if ($htype == 0) { # INIT
320 my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl"); 498 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
499
500 my %want_ext;
321 501
322 for my $ext (split /:/, $term->resource ("perl_ext")) { 502 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
503 if ($_ eq "default") {
504 $want_ext{$_}++ for qw(selection option-popup selection-popup);
505 } elsif (/^-(.*)$/) {
506 delete $want_ext{$1};
507 } else {
508 $want_ext{$_}++;
509 }
510 }
511
512 for my $ext (keys %want_ext) {
323 my @files = grep -f $_, map "$_/$ext", @dirs; 513 my @files = grep -f $_, map "$_/$ext", @dirs;
324 514
325 if (@files) { 515 if (@files) {
326 register_package script_package $files[0]; 516 register_package extension_package $files[0];
327 } else { 517 } else {
328 warn "perl extension '$ext' not found in perl library search path\n"; 518 warn "perl extension '$ext' not found in perl library search path\n";
329 } 519 }
330 } 520 }
331 521
522 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
523 warn $@ if $@;
524 }
525
526 $retval = undef;
527
528 if (my $cb = $TERM->{_hook}[$htype]) {
529 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
530 if $verbosity >= 10;
531
532 keys %$cb;
533
534 while (my ($pkg, $cb) = each %$cb) {
535 eval {
536 $retval = $cb->(
537 $TERM->{_pkg}{$pkg} ||= do {
538 my $proxy = bless { }, $pkg;
539 Scalar::Util::weaken ($proxy->{term} = $TERM);
540 $proxy
541 },
542 @_,
543 ) and last;
544 };
545 if ($@) {
546 $TERM->ungrab; # better to lose the grab than the session
547 warn $@;
548 }
549 }
550 }
551
332 } elsif ($htype == 1) { # DESTROY 552 if ($htype == 1) { # DESTROY
553 # remove hooks if unused
333 if (my $hook = $term->{_hook}) { 554 if (my $hook = $TERM->{_hook}) {
334 for my $htype (0..$#$hook) { 555 for my $htype (0..$#$hook) {
335 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } 556 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
336 or set_should_invoke $htype, 0; 557 or set_should_invoke $htype, 0;
337 } 558 }
338 } 559 }
560
561 # clear package objects
562 %$_ = () for values %{ $TERM->{_pkg} };
563
564 # clear package
565 %$TERM = ();
339 } 566 }
340 567
341 my $cb = $term->{_hook}[$htype] 568 $retval
342 or return; 569}
343 570
344 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")" 571# urxvt::term::proxy
345 if $verbosity >= 10;
346 572
347 while (my ($k, $v) = each %$cb) { 573sub urxvt::term::proxy::AUTOLOAD {
348 return 1 if $v->($term, @_); 574 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
575 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
576
577 eval qq{
578 sub $urxvt::term::proxy::AUTOLOAD {
579 my \$proxy = shift;
580 \$proxy->{term}->$1 (\@_)
581 }
582 1
583 } or die "FATAL: unable to compile method forwarder: $@";
584
585 goto &$urxvt::term::proxy::AUTOLOAD;
586}
587
588sub urxvt::term::proxy::DESTROY {
589 # nop
590}
591
592# urxvt::destroy_hook
593
594sub urxvt::destroy_hook::DESTROY {
595 ${$_[0]}->();
596}
597
598sub urxvt::destroy_hook(&) {
599 bless \shift, urxvt::destroy_hook::
600}
601
602package urxvt::anyevent;
603
604=head2 The C<urxvt::anyevent> Class
605
606The sole purpose of this class is to deliver an interface to the
607C<AnyEvent> module - any module using it will work inside urxvt without
608further work. The only exception is that you cannot wait on condition
609variables, but non-blocking condvar use is ok. What this means is that you
610cannot use blocking APIs, but the non-blocking variant should work.
611
612=cut
613
614our $VERSION = 1;
615
616$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
617push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
618
619sub timer {
620 my ($class, %arg) = @_;
621
622 my $cb = $arg{cb};
623
624 urxvt::timer
625 ->new
626 ->start (urxvt::NOW + $arg{after})
627 ->cb (sub {
628 $_[0]->stop; # need to cancel manually
629 $cb->();
630 })
631}
632
633sub io {
634 my ($class, %arg) = @_;
635
636 my $cb = $arg{cb};
637
638 bless [$arg{fh}, urxvt::iow
639 ->new
640 ->fd (fileno $arg{fh})
641 ->events (($arg{poll} =~ /r/ ? 1 : 0)
642 | ($arg{poll} =~ /w/ ? 2 : 0))
643 ->start
644 ->cb (sub {
645 $cb->(($_[1] & 1 ? 'r' : '')
646 . ($_[1] & 2 ? 'w' : ''));
647 })],
648 urxvt::anyevent::
649}
650
651sub DESTROY {
652 $_[0][1]->stop;
653}
654
655sub condvar {
656 bless \my $flag, urxvt::anyevent::condvar::
657}
658
659sub urxvt::anyevent::condvar::broadcast {
660 ${$_[0]}++;
661}
662
663sub urxvt::anyevent::condvar::wait {
664 unless (${$_[0]}) {
665 require Carp;
666 Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");
349 } 667 }
350
351 0
352} 668}
353 669
354=back 670package urxvt::term;
355 671
356=head2 The C<urxvt::term> Class 672=head2 The C<urxvt::term> Class
357 673
358=over 4 674=over 4
675
676=item $term->destroy
677
678Destroy the terminal object (close the window, free resources etc.).
679
680=item $isset = $term->option ($optval[, $set])
681
682Returns true if the option specified by C<$optval> is enabled, and
683optionally change it. All option values are stored by name in the hash
684C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
685
686Here is a a likely non-exhaustive list of option names, please see the
687source file F</src/optinc.h> to see the actual list:
688
689 borderLess console cursorBlink cursorUnderline hold iconic insecure
690 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
691 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
692 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
693 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
694 tripleclickwords utmpInhibit visualBell
359 695
360=item $value = $term->resource ($name[, $newval]) 696=item $value = $term->resource ($name[, $newval])
361 697
362Returns the current resource value associated with a given name and 698Returns the current resource value associated with a given name and
363optionally sets a new value. Setting values is most useful in the C<init> 699optionally sets a new value. Setting values is most useful in the C<init>
373 709
374Please note that resource strings will currently only be freed when the 710Please note that resource strings will currently only be freed when the
375terminal is destroyed, so changing options frequently will eat memory. 711terminal is destroyed, so changing options frequently will eat memory.
376 712
377Here is a a likely non-exhaustive list of resource names, not all of which 713Here is a a likely non-exhaustive list of resource names, not all of which
378are supported in every build, please see the source to see the actual 714are supported in every build, please see the source file F</src/rsinc.h>
379list: 715to see the actual list:
380 716
381 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 717 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
382 borderLess color cursorBlink cursorUnderline cutchars delete_key 718 borderLess color cursorBlink cursorUnderline cutchars delete_key
383 display_name embed ext_bwidth fade font geometry hold iconName 719 display_name embed ext_bwidth fade font geometry hold iconName
384 imFont imLocale inputMethod insecure int_bwidth intensityStyles 720 imFont imLocale inputMethod insecure int_bwidth intensityStyles
385 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 721 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
386 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext 722 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
387 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 723 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
388 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 724 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
389 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 725 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
390 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 726 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
391 shade term_name title transparent transparent_all tripleclickwords 727 shade term_name title transparent transparent_all tripleclickwords
392 utmpInhibit visualBell 728 utmpInhibit visualBell
393 729
394=cut 730=cut
395 731
396sub urxvt::term::resource($$;$) { 732sub resource($$;$) {
397 my ($self, $name) = (shift, shift); 733 my ($self, $name) = (shift, shift);
398 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 734 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
399 goto &urxvt::term::_resource; 735 &urxvt::term::_resource
400} 736}
737
738=item $rend = $term->rstyle ([$new_rstyle])
739
740Return and optionally change the current rendition. Text that is output by
741the terminal application will use this style.
742
743=item ($row, $col) = $term->screen_cur ([$row, $col])
744
745Return the current coordinates of the text cursor position and optionally
746set it (which is usually bad as applications don't expect that).
401 747
402=item ($row, $col) = $term->selection_mark ([$row, $col]) 748=item ($row, $col) = $term->selection_mark ([$row, $col])
403 749
404=item ($row, $col) = $term->selection_beg ([$row, $col]) 750=item ($row, $col) = $term->selection_beg ([$row, $col])
405 751
415 761
416=item $oldtext = $term->selection ([$newtext]) 762=item $oldtext = $term->selection ([$newtext])
417 763
418Return the current selection text and optionally replace it by C<$newtext>. 764Return the current selection text and optionally replace it by C<$newtext>.
419 765
420=item $term->scr_overlay ($x, $y, $text) 766#=item $term->overlay ($x, $y, $text)
421 767#
422Create a simple multi-line overlay box. See the next method for details. 768#Create a simple multi-line overlay box. See the next method for details.
769#
770#=cut
771#
772#sub urxvt::term::scr_overlay {
773# my ($self, $x, $y, $text) = @_;
774#
775# my @lines = split /\n/, $text;
776#
777# my $w = 0;
778# for (map $self->strwidth ($_), @lines) {
779# $w = $_ if $w < $_;
780# }
781#
782# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
783# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
784#}
785
786=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
787
788Create a new (empty) overlay at the given position with the given
789width/height. C<$rstyle> defines the initial rendition style
790(default: C<OVERLAY_RSTYLE>).
791
792If C<$border> is C<2> (default), then a decorative border will be put
793around the box.
794
795If either C<$x> or C<$y> is negative, then this is counted from the
796right/bottom side, respectively.
797
798This method returns an urxvt::overlay object. The overlay will be visible
799as long as the perl object is referenced.
800
801The methods currently supported on C<urxvt::overlay> objects are:
802
803=over 4
804
805=item $overlay->set ($x, $y, $text, $rend)
806
807Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
808text in rxvt-unicode's special encoding and an array of rendition values
809at a specific position inside the overlay.
810
811=item $overlay->hide
812
813If visible, hide the overlay, but do not destroy it.
814
815=item $overlay->show
816
817If hidden, display the overlay again.
818
819=back
820
821=item $popup = $term->popup ($event)
822
823Creates a new C<urxvt::popup> object that implements a popup menu. The
824C<$event> I<must> be the event causing the menu to pop up (a button event,
825currently).
423 826
424=cut 827=cut
425 828
426sub urxvt::term::scr_overlay { 829sub popup {
427 my ($self, $x, $y, $text) = @_; 830 my ($self, $event) = @_;
428 831
429 my @lines = split /\n/, $text; 832 $self->grab ($event->{time}, 1)
833 or return;
430 834
431 my $w = 0; 835 my $popup = bless {
432 for (map $self->strwidth ($_), @lines) { 836 term => $self,
433 $w = $_ if $w < $_; 837 event => $event,
434 } 838 }, urxvt::popup::;
435 839
436 $self->scr_overlay_new ($x, $y, $w, scalar @lines); 840 Scalar::Util::weaken $popup->{term};
437 $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
438}
439 841
440=item $term->scr_overlay_new ($x, $y, $width, $height) 842 $self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
843 Scalar::Util::weaken $self->{_destroy}{$popup};
441 844
442Create a new (empty) overlay at the given position with the given 845 $popup
443width/height. A border will be put around the box. If either C<$x> or 846}
444C<$y> is negative, then this is counted from the right/bottom side,
445respectively.
446 847
447=item $term->scr_overlay_off
448
449Switch the overlay off again.
450
451=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)
452
453Put a single character (specified numerically) at the given overlay
454position.
455
456=item $term->scr_overlay_set ($x, $y, $text)
457
458Write a string at the given position into the overlay.
459
460=item $cellwidth = $term->strwidth $string 848=item $cellwidth = $term->strwidth ($string)
461 849
462Returns the number of screen-cells this string would need. Correctly 850Returns the number of screen-cells this string would need. Correctly
463accounts for wide and combining characters. 851accounts for wide and combining characters.
464 852
465=item $octets = $term->locale_encode $string 853=item $octets = $term->locale_encode ($string)
466 854
467Convert the given text string into the corresponding locale encoding. 855Convert the given text string into the corresponding locale encoding.
468 856
469=item $string = $term->locale_decode $octets 857=item $string = $term->locale_decode ($octets)
470 858
471Convert the given locale-encoded octets into a perl string. 859Convert the given locale-encoded octets into a perl string.
860
861=item $term->scr_add_lines ($string)
862
863Write the given text string to the screen, as if output by the application
864running inside the terminal. It may not contain command sequences (escape
865codes), but is free to use line feeds, carriage returns and tabs. The
866string is a normal text string, not in locale-dependent encoding.
867
868Normally its not a good idea to use this function, as programs might be
869confused by changes in cursor position or scrolling. Its useful inside a
870C<on_add_lines> hook, though.
871
872=item $term->cmd_parse ($octets)
873
874Similar to C<scr_add_lines>, but the argument must be in the
875locale-specific encoding of the terminal and can contain command sequences
876(escape codes) that will be interpreted.
472 877
473=item $term->tt_write ($octets) 878=item $term->tt_write ($octets)
474 879
475Write the octets given in C<$data> to the tty (i.e. as program input). To 880Write the octets given in C<$data> to the tty (i.e. as program input). To
476pass characters instead of octets, you should convert your strings first 881pass characters instead of octets, you should convert your strings first
477to the locale-specific encoding using C<< $term->locale_encode >>. 882to the locale-specific encoding using C<< $term->locale_encode >>.
478 883
884=item $windowid = $term->parent
885
886Return the window id of the toplevel window.
887
888=item $windowid = $term->vt
889
890Return the window id of the terminal window.
891
892=item $window_width = $term->width
893
894=item $window_height = $term->height
895
896=item $font_width = $term->fwidth
897
898=item $font_height = $term->fheight
899
900=item $font_ascent = $term->fbase
901
479=item $nrow = $term->nrow 902=item $terminal_rows = $term->nrow
480 903
481=item $ncol = $term->ncol 904=item $terminal_columns = $term->ncol
482 905
483Return the number of rows/columns of the terminal window (i.e. as 906=item $has_focus = $term->focus
484specified by C<-geometry>, excluding any scrollback).
485 907
486=item $nsaved = $term->nsaved 908=item $is_mapped = $term->mapped
487 909
488Returns the number of lines in the scrollback buffer. 910=item $max_scrollback = $term->saveLines
911
912=item $nrow_plus_saveLines = $term->total_rows
913
914=item $lines_in_scrollback = $term->nsaved
915
916Return various integers describing terminal characteristics.
917
918=item $modifiermask = $term->ModLevel3Mask
919
920=item $modifiermask = $term->ModMetaMask
921
922=item $modifiermask = $term->ModNumLockMask
923
924Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
925AltGr), the meta key (often Alt) and the num lock key, if applicable.
489 926
490=item $view_start = $term->view_start ([$newvalue]) 927=item $view_start = $term->view_start ([$newvalue])
491 928
492Returns the negative row number of the topmost line. Minimum value is 929Returns the negative row number of the topmost line. Minimum value is
493C<0>, which displays the normal terminal contents. Larger values scroll 930C<0>, which displays the normal terminal contents. Larger values scroll
504=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 941=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
505 942
506Returns the text of the entire row with number C<$row_number>. Row C<0> 943Returns the text of the entire row with number C<$row_number>. Row C<0>
507is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 944is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
508terminal line. The scrollback buffer starts at line C<-1> and extends to 945terminal line. The scrollback buffer starts at line C<-1> and extends to
509line C<< -$term->nsaved >>. 946line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
947is requested.
510 948
511If C<$new_text> is specified, it will replace characters in the current 949If C<$new_text> is specified, it will replace characters in the current
512line, starting at column C<$start_col> (default C<0>), which is useful 950line, starting at column C<$start_col> (default C<0>), which is useful
513to replace only parts of a line. The font index in the rendition will 951to replace only parts of a line. The font index in the rendition will
514automatically be updated. 952automatically be updated.
536 974
537See the section on RENDITION, above. 975See the section on RENDITION, above.
538 976
539=item $length = $term->ROW_l ($row_number[, $new_length]) 977=item $length = $term->ROW_l ($row_number[, $new_length])
540 978
541Returns the number of screen cells that are in use ("the line length"). If 979Returns the number of screen cells that are in use ("the line
542it is C<-1>, then the line is part of a multiple-row logical "line", which 980length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
543means all characters are in use and it is continued on the next row. 981line is joined with the following one.
544 982
983=item $bool = $term->is_longer ($row_number)
984
985Returns true if the row is part of a multiple-row logical "line" (i.e.
986joined with the following row), which means all characters are in use
987and it is continued on the next row (and possibly a continuation of the
988previous row(s)).
989
990=item $line = $term->line ($row_number)
991
992Create and return a new C<urxvt::line> object that stores information
993about the logical line that row C<$row_number> is part of. It supports the
994following methods:
995
996=over 4
997
998=item $text = $line->t ([$new_text])
999
1000Returns or replaces the full text of the line, similar to C<ROW_t>
1001
1002=item $rend = $line->r ([$new_rend])
1003
1004Returns or replaces the full rendition array of the line, similar to C<ROW_r>
1005
1006=item $length = $line->l
1007
1008Returns the length of the line in cells, similar to C<ROW_l>.
1009
1010=item $rownum = $line->beg
1011
1012=item $rownum = $line->end
1013
1014Return the row number of the first/last row of the line, respectively.
1015
1016=item $offset = $line->offset_of ($row, $col)
1017
1018Returns the character offset of the given row|col pair within the logical
1019line.
1020
1021=item ($row, $col) = $line->coord_of ($offset)
1022
1023Translates a string offset into terminal coordinates again.
1024
1025=back
1026
1027=cut
1028
1029sub line {
1030 my ($self, $row) = @_;
1031
1032 my $maxrow = $self->nrow - 1;
1033
1034 my ($beg, $end) = ($row, $row);
1035
1036 --$beg while $self->ROW_is_longer ($beg - 1);
1037 ++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
1038
1039 bless {
1040 term => $self,
1041 beg => $beg,
1042 end => $end,
1043 ncol => $self->ncol,
1044 len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
1045 }, urxvt::line::
1046}
1047
1048sub urxvt::line::t {
1049 my ($self) = @_;
1050
1051 if (@_ > 1)
1052 {
1053 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1054 for $self->{beg} .. $self->{end};
1055 }
1056
1057 defined wantarray &&
1058 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1059 0, $self->{len}
1060}
1061
1062sub urxvt::line::r {
1063 my ($self) = @_;
1064
1065 if (@_ > 1)
1066 {
1067 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1068 for $self->{beg} .. $self->{end};
1069 }
1070
1071 if (defined wantarray) {
1072 my $rend = [
1073 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1074 ];
1075 $#$rend = $self->{len} - 1;
1076 return $rend;
1077 }
1078
1079 ()
1080}
1081
1082sub urxvt::line::beg { $_[0]{beg} }
1083sub urxvt::line::end { $_[0]{end} }
1084sub urxvt::line::l { $_[0]{len} }
1085
1086sub urxvt::line::offset_of {
1087 my ($self, $row, $col) = @_;
1088
1089 ($row - $self->{beg}) * $self->{ncol} + $col
1090}
1091
1092sub urxvt::line::coord_of {
1093 my ($self, $offset) = @_;
1094
1095 use integer;
1096
1097 (
1098 $offset / $self->{ncol} + $self->{beg},
1099 $offset % $self->{ncol}
1100 )
1101}
1102
1103=item ($row, $col) = $line->coord_of ($offset)
545=item $text = $term->special_encode $string 1104=item $text = $term->special_encode $string
546 1105
547Converts a perl string into the special encoding used by rxvt-unicode, 1106Converts a perl string into the special encoding used by rxvt-unicode,
548where one character corresponds to one screen cell. See 1107where one character corresponds to one screen cell. See
549C<< $term->ROW_t >> for details. 1108C<< $term->ROW_t >> for details.
553Converts rxvt-unicodes text reprsentation into a perl string. See 1112Converts rxvt-unicodes text reprsentation into a perl string. See
554C<< $term->ROW_t >> for details. 1113C<< $term->ROW_t >> for details.
555 1114
556=back 1115=back
557 1116
1117=cut
1118
1119package urxvt::popup;
1120
1121=head2 The C<urxvt::popup> Class
1122
1123=over 4
1124
1125=cut
1126
1127sub add_item {
1128 my ($self, $item) = @_;
1129
1130 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
1131 $item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
1132 $item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
1133
1134 $item->{render} ||= sub { $_[0]{text} };
1135
1136 push @{ $self->{item} }, $item;
1137}
1138
1139sub add_separator {
1140 my ($self, $sep) = @_;
1141
1142 $sep ||= "═";
1143
1144 $self->add_item ({
1145 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1146 text => "",
1147 render => sub { $sep x $urxvt::TERM->ncol },
1148 activate => sub { },
1149 });
1150}
1151
1152sub add_title {
1153 my ($self, $title) = @_;
1154
1155 $self->add_item ({
1156 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
1157 text => $title,
1158 activate => sub { },
1159 });
1160}
1161
1162sub add_button {
1163 my ($self, $text, $cb) = @_;
1164
1165 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});
1166}
1167
1168sub add_toggle {
1169 my ($self, $text, $cb, $value) = @_;
1170
1171 my $item; $item = {
1172 type => "button",
1173 text => " $text",
1174 value => $value,
1175 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1176 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
1177 };
1178
1179 $self->add_item ($item);
1180}
1181
1182sub show {
1183 my ($self) = @_;
1184
1185 local $urxvt::popup::self = $self;
1186
1187 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1188 "--transient-for" => $self->{term}->parent,
1189 "-pe" => "urxvt-popup")
1190 or die "unable to create popup window\n";
1191}
1192
1193sub DESTROY {
1194 my ($self) = @_;
1195
1196 delete $self->{term}{_destroy}{$self};
1197 $self->{term}->ungrab;
1198}
1199
558=head2 The C<urxvt::timer> Class 1200=head2 The C<urxvt::timer> Class
559 1201
560This class implements timer watchers/events. Time is represented as a 1202This class implements timer watchers/events. Time is represented as a
561fractional number of seconds since the epoch. Example: 1203fractional number of seconds since the epoch. Example:
562 1204
563 # create a digital clock display in upper right corner 1205 $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
564 $term->{timer} = urxvt::timer 1206 $term->{timer} = urxvt::timer
565 ->new 1207 ->new
566 ->start (urxvt::NOW) 1208 ->interval (1)
567 ->cb (sub { 1209 ->cb (sub {
568 my ($timer) = @_;
569 my $time = $timer->at;
570 $timer->start ($time + 1);
571 $self->scr_overlay (-1, 0, 1210 $term->{overlay}->set (0, 0,
572 POSIX::strftime "%H:%M:%S", localtime $time); 1211 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
573 }); 1212 });
574 1213
575=over 4 1214=over 4
576 1215
577=item $timer = new urxvt::timer 1216=item $timer = new urxvt::timer
578 1217
579Create a new timer object in stopped state. 1218Create a new timer object in started state. It is scheduled to fire
1219immediately.
580 1220
581=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 1221=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
582 1222
583Set the callback to be called when the timer triggers. 1223Set the callback to be called when the timer triggers.
584 1224
587Return the time this watcher will fire next. 1227Return the time this watcher will fire next.
588 1228
589=item $timer = $timer->set ($tstamp) 1229=item $timer = $timer->set ($tstamp)
590 1230
591Set the time the event is generated to $tstamp. 1231Set the time the event is generated to $tstamp.
1232
1233=item $timer = $timer->interval ($interval)
1234
1235Normally (and when C<$interval> is C<0>), the timer will automatically
1236stop after it has fired once. If C<$interval> is non-zero, then the timer
1237is automatically rescheduled at the given intervals.
592 1238
593=item $timer = $timer->start 1239=item $timer = $timer->start
594 1240
595Start the timer. 1241Start the timer.
596 1242
659This variable controls the verbosity level of the perl extension. Higher 1305This variable controls the verbosity level of the perl extension. Higher
660numbers indicate more verbose output. 1306numbers indicate more verbose output.
661 1307
662=over 4 1308=over 4
663 1309
664=item 0 - only fatal messages 1310=item == 0 - fatal messages
665 1311
666=item 3 - script loading and management 1312=item >= 3 - script loading and management
667 1313
668=item 10 - all events received 1314=item >=10 - all events received
669 1315
670=back 1316=back
671 1317
672=head1 AUTHOR 1318=head1 AUTHOR
673 1319

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines