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.1 by root, Mon Jan 2 15:35:43 2006 UTC vs.
Revision 1.61 by root, Mon Jan 9 01:36:56 2006 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines