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.10 by root, Mon Jan 2 20:47:52 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 # create a file grab_test in $HOME: 9 # create a file grab_test in $HOME:
8 10
15 17
16 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test 18 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
17 19
18=head1 DESCRIPTION 20=head1 DESCRIPTION
19 21
20Everytime a terminal object gets created, scripts specified via the 22Everytime a terminal object gets created, extension scripts specified via
21C<perl> resource are loaded and associated with it. 23the C<perl> resource are loaded and associated with it.
22 24
23Scripts are compiled in a 'use strict' and 'use utf8' environment, and 25Scripts are compiled in a 'use strict' and 'use utf8' environment, and
24thus must be encoded as UTF-8. 26thus must be encoded as UTF-8.
25 27
26Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where 28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
27scripts will be shared (But not enabled) for all terminals. 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
28 92
29=head2 General API Considerations 93=head2 General API Considerations
30 94
31All objects (such as terminals, time watchers etc.) are typical 95All objects (such as terminals, time watchers etc.) are typical
32reference-to-hash objects. The hash can be used to store anything you 96reference-to-hash objects. The hash can be used to store anything you
33like. All members starting with an underscore (such as C<_ptr> or 97like. All members starting with an underscore (such as C<_ptr> or
34C<_hook>) are reserved for internal uses and must not be accessed or 98C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
35modified). 99modified).
36 100
37When objects are destroyed on the C++ side, the perl object hashes are 101When objects are destroyed on the C++ side, the perl object hashes are
38emptied, so its best to store related objects such as time watchers and 102emptied, so its best to store related objects such as time watchers and
39the like inside the terminal object so they get destroyed as soon as the 103the like inside the terminal object so they get destroyed as soon as the
40terminal is destroyed. 104terminal is destroyed.
41 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
42=head2 Hooks 129=head2 Hooks
43 130
44The following subroutines can be declared in loaded scripts, and will be called 131The following subroutines can be declared in extension files, and will be
45whenever 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.
46 140
47All 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
48counts 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,
49and 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.
50 144
53=over 4 147=over 4
54 148
55=item on_init $term 149=item on_init $term
56 150
57Called after a new terminal object has been initialized, but before 151Called after a new terminal object has been initialized, but before
58windows 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.
59 156
60=item on_reset $term 157=item on_reset $term
61 158
62Called 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
63control 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
83requested from the server. The selection text can be queried and changed 180requested from the server. The selection text can be queried and changed
84by calling C<< $term->selection >>. 181by calling C<< $term->selection >>.
85 182
86Returning a true value aborts selection grabbing. It will still be hilighted. 183Returning a true value aborts selection grabbing. It will still be hilighted.
87 184
88=item on_focus_in $term 185=item on_sel_extend $term
89 186
90Called whenever the window gets the keyboard focus, before urxvt does 187Called whenever the user tries to extend the selection (e.g. with a double
91focus in processing. 188click) and is either supposed to return false (normal operation), or
92 189should extend the selection itelf and return true to suppress the built-in
93=item on_focus_out $term
94
95Called wheneever the window loses keyboard focus, before urxvt does focus
96out processing. 190processing.
191
192See the F<selection> example extension.
97 193
98=item on_view_change $term, $offset 194=item on_view_change $term, $offset
99 195
100Called whenever the view offset changes, i..e the user or program 196Called whenever the view offset changes, i..e the user or program
101scrolls. Offset C<0> means display the normal terminal, positive values 197scrolls. Offset C<0> means display the normal terminal, positive values
112number of lines that will be in the scrollback buffer. 208number of lines that will be in the scrollback buffer.
113 209
114=item on_tty_activity $term *NYI* 210=item on_tty_activity $term *NYI*
115 211
116Called 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.
117 248
118=item on_refresh_begin $term 249=item on_refresh_begin $term
119 250
120Called just before the screen gets redrawn. Can be used for overlay 251Called just before the screen gets redrawn. Can be used for overlay
121or similar effects by modify terminal contents in refresh_begin, and 252or similar effects by modify terminal contents in refresh_begin, and
124 255
125=item on_refresh_end $term 256=item on_refresh_end $term
126 257
127Called just after the screen gets redrawn. See C<on_refresh_begin>. 258Called just after the screen gets redrawn. See C<on_refresh_begin>.
128 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
129=back 302=back
130 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
131=head2 Functions in the C<urxvt> Package 315=head2 Functions in the C<urxvt> Package
132 316
133=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.
134 326
135=item urxvt::fatal $errormessage 327=item urxvt::fatal $errormessage
136 328
137Fatally aborts execution with the given error message. Avoid at all 329Fatally aborts execution with the given error message. Avoid at all
138costs! The only time this is acceptable is when the terminal process 330costs! The only time this is acceptable is when the terminal process
149 341
150=item $time = urxvt::NOW 342=item $time = urxvt::NOW
151 343
152Returns the "current time" (as per the event loop). 344Returns the "current time" (as per the event loop).
153 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
154=cut 408=cut
155 409
156package urxvt; 410package urxvt;
157 411
412use utf8;
158use strict; 413use strict;
414use Scalar::Util ();
415use List::Util ();
159 416
160our $term; 417our $VERSION = 1;
418our $TERM;
161our @HOOKNAME; 419our @HOOKNAME;
420our %OPTION;
162our $LIBDIR; 421our $LIBDIR;
163 422
164BEGIN { 423BEGIN {
165 urxvt->bootstrap; 424 urxvt->bootstrap;
166 425
169 my $msg = join "", @_; 428 my $msg = join "", @_;
170 $msg .= "\n" 429 $msg .= "\n"
171 unless $msg =~ /\n$/; 430 unless $msg =~ /\n$/;
172 urxvt::warn ($msg); 431 urxvt::warn ($msg);
173 }; 432 };
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";
174} 438}
175 439
176my @hook_count; 440my @hook_count;
177my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 441my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
178 442
190 my $name = $HOOKNAME[$htype]; 454 my $name = $HOOKNAME[$htype];
191 455
192 my $ref = $pkg->can ("on_" . lc $name) 456 my $ref = $pkg->can ("on_" . lc $name)
193 or next; 457 or next;
194 458
195 $term->{_hook}[$htype]{$ref*1} = $ref; 459 $TERM->{_hook}[$htype]{$pkg} = $ref;
196 $hook_count[$htype]++ 460 $hook_count[$htype]++
197 or set_should_invoke $htype, 1; 461 or set_should_invoke $htype, 1;
198 } 462 }
199} 463}
200 464
201my $script_pkg = "script0000"; 465my $extension_pkg = "extension0000";
202my %script_pkg; 466my %extension_pkg;
203 467
204# load a single script into its own package, once only 468# load a single script into its own package, once only
205sub script_package($) { 469sub extension_package($) {
206 my ($path) = @_; 470 my ($path) = @_;
207 471
208 $script_pkg{$path} ||= do { 472 $extension_pkg{$path} ||= do {
209 my $pkg = "urxvt::" . ($script_pkg++); 473 my $pkg = "urxvt::" . ($extension_pkg++);
210 474
211 verbose 3, "loading script '$path' into package '$pkg'"; 475 verbose 3, "loading extension '$path' into package '$pkg'";
212 476
213 open my $fh, "<:raw", $path 477 open my $fh, "<:raw", $path
214 or die "$path: $!"; 478 or die "$path: $!";
215 479
216 my $source = "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"
217 . "#line 1 \"$path\"\n{\n" 482 . "#line 1 \"$path\"\n{\n"
218 . (do { local $/; <$fh> }) 483 . (do { local $/; <$fh> })
219 . "\n};\n1"; 484 . "\n};\n1";
220 485
221 eval $source or die "$path: $@"; 486 eval $source or die "$path: $@";
222 487
223 $pkg 488 $pkg
224 } 489 }
225} 490}
226 491
492our $retval; # return value for urxvt
493
227# called by the rxvt core 494# called by the rxvt core
228sub invoke { 495sub invoke {
229 local $term = shift; 496 local $TERM = shift;
230 my $htype = shift; 497 my $htype = shift;
231 498
232 if ($htype == 0) { # INIT 499 if ($htype == 0) { # INIT
233 my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl"); 500 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
501
502 my %want_ext;
234 503
235 for my $ext (split /:/, $term->resource ("perl_ext")) { 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) {
236 my @files = grep -f $_, map "$_/$ext", @dirs; 515 my @files = grep -f $_, map "$_/$ext", @dirs;
237 516
238 if (@files) { 517 if (@files) {
239 register_package script_package $files[0]; 518 register_package extension_package $files[0];
240 } else { 519 } else {
241 warn "perl extension '$ext' not found in perl library search path\n"; 520 warn "perl extension '$ext' not found in perl library search path\n";
242 } 521 }
243 } 522 }
244 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
245 } elsif ($htype == 1) { # DESTROY 554 if ($htype == 1) { # DESTROY
555 # remove hooks if unused
246 if (my $hook = $term->{_hook}) { 556 if (my $hook = $TERM->{_hook}) {
247 for my $htype (0..$#$hook) { 557 for my $htype (0..$#$hook) {
248 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } 558 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
249 or set_should_invoke $htype, 0; 559 or set_should_invoke $htype, 0;
250 } 560 }
251 } 561 }
562
563 # clear package objects
564 %$_ = () for values %{ $TERM->{_pkg} };
565
566 # clear package
567 %$TERM = ();
252 } 568 }
253 569
254 my $cb = $term->{_hook}[$htype] 570 $retval
255 or return; 571}
256 572
257 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")" 573# urxvt::term::proxy
258 if $verbosity >= 10;
259 574
260 while (my ($k, $v) = each %$cb) { 575sub urxvt::term::proxy::AUTOLOAD {
261 return 1 if $v->($term, @_); 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");
262 } 669 }
263
264 0
265} 670}
266 671
267=back 672package urxvt::term;
268 673
269=head2 The C<urxvt::term> Class 674=head2 The C<urxvt::term> Class
270 675
271=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
272 697
273=item $value = $term->resource ($name[, $newval]) 698=item $value = $term->resource ($name[, $newval])
274 699
275Returns the current resource value associated with a given name and 700Returns the current resource value associated with a given name and
276optionally 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>
286 711
287Please note that resource strings will currently only be freed when the 712Please note that resource strings will currently only be freed when the
288terminal is destroyed, so changing options frequently will eat memory. 713terminal is destroyed, so changing options frequently will eat memory.
289 714
290Here 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
291are 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>
292list: 717to see the actual list:
293 718
294 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 719 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
295 borderLess color cursorBlink cursorUnderline cutchars delete_key 720 borderLess color cursorBlink cursorUnderline cutchars delete_key
296 display_name embed ext_bwidth fade font geometry hold iconName 721 display_name embed ext_bwidth fade font geometry hold iconName
297 imFont imLocale inputMethod insecure int_bwidth intensityStyles 722 imFont imLocale inputMethod insecure int_bwidth intensityStyles
298 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 723 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
299 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext 724 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
300 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 725 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
301 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 726 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
302 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 727 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
303 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 728 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
304 shade term_name title transparent transparent_all tripleclickwords 729 shade term_name title transparent transparent_all tripleclickwords
305 utmpInhibit visualBell 730 utmpInhibit visualBell
306 731
307=cut 732=cut
308 733
309sub urxvt::term::resource($$;$) { 734sub resource($$;$) {
310 my ($self, $name) = (shift, shift); 735 my ($self, $name) = (shift, shift);
311 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 736 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
312 goto &urxvt::term::_resource; 737 &urxvt::term::_resource
313} 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).
314 749
315=item ($row, $col) = $term->selection_mark ([$row, $col]) 750=item ($row, $col) = $term->selection_mark ([$row, $col])
316 751
317=item ($row, $col) = $term->selection_beg ([$row, $col]) 752=item ($row, $col) = $term->selection_beg ([$row, $col])
318 753
328 763
329=item $oldtext = $term->selection ([$newtext]) 764=item $oldtext = $term->selection ([$newtext])
330 765
331Return the current selection text and optionally replace it by C<$newtext>. 766Return the current selection text and optionally replace it by C<$newtext>.
332 767
333=item $term->scr_overlay ($x, $y, $text) 768#=item $term->overlay ($x, $y, $text)
334 769#
335Create 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).
336 828
337=cut 829=cut
338 830
339sub urxvt::term::scr_overlay { 831sub popup {
340 my ($self, $x, $y, $text) = @_; 832 my ($self, $event) = @_;
341 833
342 my @lines = split /\n/, $text; 834 $self->grab ($event->{time}, 1)
835 or return;
343 836
344 my $w = 0; 837 my $popup = bless {
345 for (map $self->strwidth ($_), @lines) { 838 term => $self,
346 $w = $_ if $w < $_; 839 event => $event,
347 } 840 }, urxvt::popup::;
348 841
349 $self->scr_overlay_new ($x, $y, $w, scalar @lines); 842 Scalar::Util::weaken $popup->{term};
350 $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
351}
352 843
353=item $term->scr_overlay_new ($x, $y, $width, $height) 844 $self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
845 Scalar::Util::weaken $self->{_destroy}{$popup};
354 846
355Create a new (empty) overlay at the given position with the given 847 $popup
356width/height. A border will be put around the box. If either C<$x> or 848}
357C<$y> is negative, then this is counted from the right/bottom side,
358respectively.
359 849
360=item $term->scr_overlay_off
361
362Switch the overlay off again.
363
364=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)
365
366Put a single character (specified numerically) at the given overlay
367position.
368
369=item $term->scr_overlay_set ($x, $y, $text)
370
371Write a string at the given position into the overlay.
372
373=item $cellwidth = $term->strwidth $string 850=item $cellwidth = $term->strwidth ($string)
374 851
375Returns the number of screen-cells this string would need. Correctly 852Returns the number of screen-cells this string would need. Correctly
376accounts for wide and combining characters. 853accounts for wide and combining characters.
377 854
378=item $octets = $term->locale_encode $string 855=item $octets = $term->locale_encode ($string)
379 856
380Convert the given text string into the corresponding locale encoding. 857Convert the given text string into the corresponding locale encoding.
381 858
382=item $string = $term->locale_decode $octets 859=item $string = $term->locale_decode ($octets)
383 860
384Convert the given locale-encoded octets into a perl string. 861Convert the given locale-encoded octets into a perl string.
385 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
386=item $term->tt_write ($octets) 880=item $term->tt_write ($octets)
387 881
388Write the octets given in C<$data> to the tty (i.e. as program input). To 882Write the octets given in C<$data> to the tty (i.e. as program input). To
389pass characters instead of octets, you should convetr you strings first to 883pass characters instead of octets, you should convert your strings first
390the locale-specific encoding using C<< $term->locale_encode >>. 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.
391 1026
392=back 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;
1079 }
1080
1081 ()
1082}
1083
1084sub urxvt::line::beg { $_[0]{beg} }
1085sub urxvt::line::end { $_[0]{end} }
1086sub urxvt::line::l { $_[0]{len} }
1087
1088sub urxvt::line::offset_of {
1089 my ($self, $row, $col) = @_;
1090
1091 ($row - $self->{beg}) * $self->{ncol} + $col
1092}
1093
1094sub urxvt::line::coord_of {
1095 my ($self, $offset) = @_;
1096
1097 use integer;
1098
1099 (
1100 $offset / $self->{ncol} + $self->{beg},
1101 $offset % $self->{ncol}
1102 )
1103}
1104
1105=item ($row, $col) = $line->coord_of ($offset)
1106=item $text = $term->special_encode $string
1107
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.
1116
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}
393 1201
394=head2 The C<urxvt::timer> Class 1202=head2 The C<urxvt::timer> Class
395 1203
396This class implements timer watchers/events. Time is represented as a 1204This class implements timer watchers/events. Time is represented as a
397fractional number of seconds since the epoch. Example: 1205fractional number of seconds since the epoch. Example:
398 1206
399 # create a digital clock display in upper right corner 1207 $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
400 $term->{timer} = urxvt::timer 1208 $term->{timer} = urxvt::timer
401 ->new 1209 ->new
402 ->start (urxvt::NOW) 1210 ->interval (1)
403 ->cb (sub { 1211 ->cb (sub {
404 my ($timer) = @_;
405 my $time = $timer->at;
406 $timer->start ($time + 1);
407 $self->scr_overlay (-1, 0, 1212 $term->{overlay}->set (0, 0,
408 POSIX::strftime "%H:%M:%S", localtime $time); 1213 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
409 }); 1214 });
410 1215
411=over 4 1216=over 4
412 1217
413=item $timer = new urxvt::timer 1218=item $timer = new urxvt::timer
414 1219
415Create a new timer object in stopped state. 1220Create a new timer object in started state. It is scheduled to fire
1221immediately.
416 1222
417=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 1223=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
418 1224
419Set the callback to be called when the timer triggers. 1225Set the callback to be called when the timer triggers.
420 1226
423Return the time this watcher will fire next. 1229Return the time this watcher will fire next.
424 1230
425=item $timer = $timer->set ($tstamp) 1231=item $timer = $timer->set ($tstamp)
426 1232
427Set 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.
428 1240
429=item $timer = $timer->start 1241=item $timer = $timer->start
430 1242
431Start the timer. 1243Start the timer.
432 1244
495This variable controls the verbosity level of the perl extension. Higher 1307This variable controls the verbosity level of the perl extension. Higher
496numbers indicate more verbose output. 1308numbers indicate more verbose output.
497 1309
498=over 4 1310=over 4
499 1311
500=item 0 - only fatal messages 1312=item == 0 - fatal messages
501 1313
502=item 3 - script loading and management 1314=item >= 3 - script loading and management
503 1315
504=item 10 - all events received 1316=item >=10 - all events received
505 1317
506=back 1318=back
507 1319
508=head1 AUTHOR 1320=head1 AUTHOR
509 1321

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines