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.5 by root, Mon Jan 2 17:20:00 2006 UTC vs.
Revision 1.60 by root, Mon Jan 9 01:21:43 2006 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines