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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines