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.16 by root, Tue Jan 3 01:41:06 2006 UTC vs.
Revision 1.56 by root, Sun Jan 8 05:52:42 2006 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines