ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/urxvt.pm
(Generate patch)

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.5 by root, Mon Jan 2 17:20:00 2006 UTC vs.
Revision 1.56 by root, Sun Jan 8 05:52:42 2006 UTC

1=encoding utf8
2
1=head1 NAME 3=head1 NAME
2 4
3rxvtperl - rxvt-unicode's embedded perl interpreter 5@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter
4 6
5=head1 SYNOPSIS 7=head1 SYNOPSIS
6 8
7* Put your scripts into F<@@RXVT_LIBDIR@@/urxvt/perl-ext/>, they will be loaded automatically. 9 # create a file grab_test in $HOME:
8
9* Each script will only be loaded once, even in urxvtd, and will be valid
10globally.
11
12* Scripts are evaluated in a 'use strict' and 'use utf8' environment, and
13thus must be encoded as UTF-8.
14 10
15 sub on_sel_grab { 11 sub on_sel_grab {
16 warn "you selected ", $_[0]->selection; 12 warn "you selected ", $_[0]->selection;
17 () 13 ()
18 } 14 }
19 15
20 1 16 # start a @@RXVT_NAME@@ using it:
17
18 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
21 19
22=head1 DESCRIPTION 20=head1 DESCRIPTION
23 21
22Everytime a terminal object gets created, extension scripts specified via
23the C<perl> resource are loaded and associated with it.
24
25Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26thus must be encoded as UTF-8.
27
28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29scripts will be shared (but not enabled) for all terminals.
30
31=head2 Prepackaged Extensions
32
33This section describes the extensiosn delivered with this version. You can
34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35
36You can activate them like this:
37
38 @@RXVT_NAME@@ -pe <extensionname>
39
40=over 4
41
42=item selection (enabled by default)
43
44Intelligent selection. This extension tries to be more intelligent when
45the user extends selections (double-click). Right now, it tries to select
46urls and complete shell-quoted arguments, which is very convenient, too,
47if your F<ls> supports C<--quoting-style=shell>.
48
49It also offers the following bindable event:
50
51=over 4
52
53=item rot13
54
55Rot-13 the selection when activated. Used via keyboard trigger:
56
57 URxvt.keysym.C-M-r: perl:selection:rot13
58
59=back
60
61=item option-popup (enabled by default)
62
63Binds a popup menu to Ctrl-Button3 that lets you toggle (some) options at
64runtime.
65
66=item digital-clock
67
68Displays a digital clock using the built-in overlay.
69
70=item mark-urls
71
72Uses per-line display filtering (C<on_line_update>) to underline urls.
73
74=item block-graphics-to-ascii
75
76A not very useful example of filtering all text output to the terminal,
77by replacing all line-drawing characters (U+2500 .. U+259F) by a
78similar-looking ascii character.
79
80=item example-refresh-hooks
81
82Displays a very simple digital clock in the upper right corner of the
83window. Illustrates overwriting the refresh callbacks to create your own
84overlays or changes.
85
86=back
87
88=head2 General API Considerations
89
90All objects (such as terminals, time watchers etc.) are typical
91reference-to-hash objects. The hash can be used to store anything you
92like. All members starting with an underscore (such as C<_ptr> or
93C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
94modified).
95
96When objects are destroyed on the C++ side, the perl object hashes are
97emptied, so its best to store related objects such as time watchers and
98the like inside the terminal object so they get destroyed as soon as the
99terminal is destroyed.
100
101Argument names also often indicate the type of a parameter. Here are some
102hints on what they mean:
103
104=over 4
105
106=item $text
107
108Rxvt-unicodes special way of encoding text, where one "unicode" character
109always represents one screen cell. See L<row_t> for a discussion of this format.
110
111=item $string
112
113A perl text string, with an emphasis on I<text>. It can store all unicode
114characters and is to be distinguished with text encoded in a specific
115encoding (often locale-specific) and binary data.
116
117=item $octets
118
119Either binary data or - more common - a text string encoded in a
120locale-specific way.
121
122=back
123
24=head2 Hooks 124=head2 Hooks
25 125
26The following subroutines can be declared in loaded scripts, and will be called 126The following subroutines can be declared in extension files, and will be
27whenever 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.
28 135
29All 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
30counts 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,
31and 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.
32 139
35=over 4 142=over 4
36 143
37=item on_init $term 144=item on_init $term
38 145
39Called after a new terminal object has been initialized, but before 146Called after a new terminal object has been initialized, but before
40windows 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.
41 151
42=item on_reset $term 152=item on_reset $term
43 153
44Called 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
45control 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
65requested from the server. The selection text can be queried and changed 175requested from the server. The selection text can be queried and changed
66by calling C<< $term->selection >>. 176by calling C<< $term->selection >>.
67 177
68Returning a true value aborts selection grabbing. It will still be hilighted. 178Returning a true value aborts selection grabbing. It will still be hilighted.
69 179
70=item on_focus_in $term 180=item on_sel_extend $term
71 181
72Called whenever the window gets the keyboard focus, before urxvt does 182Called whenever the user tries to extend the selection (e.g. with a double
73focus in processing. 183click) and is either supposed to return false (normal operation), or
74 184should extend the selection itelf and return true to suppress the built-in
75=item on_focus_out $term
76
77Called wheneever the window loses keyboard focus, before urxvt does focus
78out processing. 185processing.
186
187See the F<selection> example extension.
79 188
80=item on_view_change $term, $offset 189=item on_view_change $term, $offset
81 190
82Called whenever the view offset changes, i..e the user or program 191Called whenever the view offset changes, i..e the user or program
83scrolls. Offset C<0> means display the normal terminal, positive values 192scrolls. Offset C<0> means display the normal terminal, positive values
94number of lines that will be in the scrollback buffer. 203number of lines that will be in the scrollback buffer.
95 204
96=item on_tty_activity $term *NYI* 205=item on_tty_activity $term *NYI*
97 206
98Called 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.
99 243
100=item on_refresh_begin $term 244=item on_refresh_begin $term
101 245
102Called just before the screen gets redrawn. Can be used for overlay 246Called just before the screen gets redrawn. Can be used for overlay
103or similar effects by modify terminal contents in refresh_begin, and 247or similar effects by modify terminal contents in refresh_begin, and
106 250
107=item on_refresh_end $term 251=item on_refresh_end $term
108 252
109Called just after the screen gets redrawn. See C<on_refresh_begin>. 253Called just after the screen gets redrawn. See C<on_refresh_begin>.
110 254
255=item on_keyboard_command $term, $string
256
257Called whenever the user presses a key combination that has a
258C<perl:string> action bound to it (see description of the B<keysym>
259resource in the @@RXVT_NAME@@(1) manpage).
260
261=item on_focus_in $term
262
263Called whenever the window gets the keyboard focus, before rxvt-unicode
264does focus in processing.
265
266=item on_focus_out $term
267
268Called wheneever the window loses keyboard focus, before rxvt-unicode does
269focus out processing.
270
271=item on_key_press $term, $event, $octets
272
273=item on_key_release $term, $event
274
275=item on_button_press $term, $event
276
277=item on_button_release $term, $event
278
279=item on_motion_notify $term, $event
280
281=item on_map_notify $term, $event
282
283=item on_unmap_notify $term, $event
284
285Called whenever the corresponding X event is received for the terminal If
286the hook returns true, then the even will be ignored by rxvt-unicode.
287
288The event is a hash with most values as named by Xlib (see the XEvent
289manpage), with the additional members C<row> and C<col>, which are the row
290and column under the mouse cursor.
291
292C<on_key_press> additionally receives the string rxvt-unicode would
293output, if any, in locale-specific encoding.
294
295subwindow.
296
111=back 297=back
112 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
113=head2 Functions in the C<urxvt> Package 310=head2 Functions in the C<urxvt> Package
114 311
115=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.
116 321
117=item urxvt::fatal $errormessage 322=item urxvt::fatal $errormessage
118 323
119Fatally aborts execution with the given error message. Avoid at all 324Fatally aborts execution with the given error message. Avoid at all
120costs! The only time this is acceptable is when the terminal process 325costs! The only time this is acceptable is when the terminal process
121starts up. 326starts up.
122 327
123=item urxvt::warn $string 328=item urxvt::warn $string
124 329
125Calls C<rxvt_warn> witht eh given string which should not include a 330Calls C<rxvt_warn> with the given string which should not include a
126newline. The module also overwrites the C<warn> builtin with a function 331newline. The module also overwrites the C<warn> builtin with a function
127that calls this function. 332that calls this function.
128 333
129Using this function has the advantage that its output ends up in the 334Using this function has the advantage that its output ends up in the
130correct place, e.g. on stderr of the connecting urxvtc client. 335correct place, e.g. on stderr of the connecting urxvtc client.
131 336
132=item $cellwidth = urxvt::wcswidth $string
133
134Returns the number of screen-cells this string would need. Correctly
135accounts for wide and combining characters.
136
137=item $time = urxvt::NOW 337=item $time = urxvt::NOW
138 338
139Returns the "current time" (as per the event loop). 339Returns the "current time" (as per the event loop).
140 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
141=cut 403=cut
142 404
143package urxvt; 405package urxvt;
144 406
407use utf8;
145use strict; 408use strict;
409use Scalar::Util ();
410use List::Util ();
146 411
147our $term; 412our $VERSION = 1;
413our $TERM;
148our @HOOKNAME; 414our @HOOKNAME;
415our %OPTION;
149our $LIBDIR; 416our $LIBDIR;
150 417
151BEGIN { 418BEGIN {
152 urxvt->bootstrap; 419 urxvt->bootstrap;
153 420
158 unless $msg =~ /\n$/; 425 unless $msg =~ /\n$/;
159 urxvt::warn ($msg); 426 urxvt::warn ($msg);
160 }; 427 };
161} 428}
162 429
430my @hook_count;
163my $verbosity = $ENV{URXVT_PERL_VERBOSITY} || 10; 431my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
164 432
165sub verbose { 433sub verbose {
166 my ($level, $msg) = @_; 434 my ($level, $msg) = @_;
167 warn "$msg\n"; #d# 435 warn "$msg\n" if $level <= $verbosity;
168}
169
170my @invoke_cb;
171
172# called by the rxvt core
173sub invoke {
174 local $term = shift;
175 my $htype = shift;
176
177 my $cb = $invoke_cb[$htype];
178
179 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"
180 if $verbosity >= 10;
181
182 while (my ($k, $v) = each %$cb) {
183 return 1 if $v->($term, @_);
184 }
185
186 0
187} 436}
188 437
189# find on_xxx subs in the package and register them 438# find on_xxx subs in the package and register them
190# as hooks 439# as hooks
191sub register_package($) { 440sub register_package($) {
192 my ($pkg) = @_; 441 my ($pkg) = @_;
193 442
194 for my $hook (0.. $#HOOKNAME) { 443 for my $htype (0.. $#HOOKNAME) {
195 my $name = $HOOKNAME[$hook]; 444 my $name = $HOOKNAME[$htype];
196 445
197 my $ref = $pkg->can ("on_" . lc $name) 446 my $ref = $pkg->can ("on_" . lc $name)
198 or next; 447 or next;
199 448
200 $invoke_cb[$hook]{$ref*1} = $ref; 449 $TERM->{_hook}[$htype]{$pkg} = $ref;
450 $hook_count[$htype]++
201 set_should_invoke $hook, 1; 451 or set_should_invoke $htype, 1;
202 } 452 }
203} 453}
204 454
205my $script_pkg = "script0000"; 455my $extension_pkg = "extension0000";
206my %script_pkg; 456my %extension_pkg;
207 457
208# load a single script into its own package, once only 458# load a single script into its own package, once only
209sub load_script($) { 459sub extension_package($) {
210 my ($path) = @_; 460 my ($path) = @_;
211 461
212 $script_pkg{$path} ||= do { 462 $extension_pkg{$path} ||= do {
213 my $pkg = $script_pkg++; 463 my $pkg = "urxvt::" . ($extension_pkg++);
464
214 verbose 3, "loading script '$path' into package '$pkg'"; 465 verbose 3, "loading extension '$path' into package '$pkg'";
215 466
216 open my $fh, "<:raw", $path 467 open my $fh, "<:raw", $path
217 or die "$path: $!"; 468 or die "$path: $!";
218 469
219 eval "package $pkg; use strict; use utf8;\n" 470 my $source = "package $pkg; use strict; use utf8;\n"
471 . "use base urxvt::term::proxy::;\n"
220 . "#line 1 \"$path\"\n" 472 . "#line 1 \"$path\"\n{\n"
221 . do { local $/; <$fh> } 473 . (do { local $/; <$fh> })
474 . "\n};\n1";
475
222 or die "$path: $@"; 476 eval $source or die "$path: $@";
223
224 register_package $pkg;
225 477
226 $pkg 478 $pkg
227 }; 479 }
228} 480}
229 481
230load_script $_ for grep -f $_, <$LIBDIR/perl-ext/*>; 482our $retval; # return value for urxvt
231 483
232=back 484# called by the rxvt core
485sub invoke {
486 local $TERM = shift;
487 my $htype = shift;
488
489 if ($htype == 0) { # INIT
490 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
491
492 my %want_ext;
493
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) {
505 my @files = grep -f $_, map "$_/$ext", @dirs;
506
507 if (@files) {
508 register_package extension_package $files[0];
509 } else {
510 warn "perl extension '$ext' not found in perl library search path\n";
511 }
512 }
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
541 if ($htype == 1) { # DESTROY
542 # remove hooks if unused
543 if (my $hook = $TERM->{_hook}) {
544 for my $htype (0..$#$hook) {
545 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
546 or set_should_invoke $htype, 0;
547 }
548 }
549
550 # clear package objects
551 %$_ = () for values %{ $TERM->{_pkg} };
552
553 # clear package
554 %$TERM = ();
555 }
556
557 $retval
558}
559
560# urxvt::term::proxy
561
562sub urxvt::term::proxy::AUTOLOAD {
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");
652 }
653}
654
655package urxvt::term;
233 656
234=head2 The C<urxvt::term> Class 657=head2 The C<urxvt::term> Class
235 658
236=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
237 680
238=item $value = $term->resource ($name[, $newval]) 681=item $value = $term->resource ($name[, $newval])
239 682
240Returns the current resource value associated with a given name and 683Returns the current resource value associated with a given name and
241optionally 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>
251 694
252Please note that resource strings will currently only be freed when the 695Please note that resource strings will currently only be freed when the
253terminal is destroyed, so changing options frequently will eat memory. 696terminal is destroyed, so changing options frequently will eat memory.
254 697
255Here 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
256are 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>
257list: 700to see the actual list:
258 701
259 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 702 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
260 borderLess color cursorBlink cursorUnderline cutchars delete_key 703 borderLess color cursorBlink cursorUnderline cutchars delete_key
261 display_name embed ext_bwidth fade font geometry hold iconName 704 display_name embed ext_bwidth fade font geometry hold iconName
262 imFont imLocale inputMethod insecure int_bwidth intensityStyles 705 imFont imLocale inputMethod insecure int_bwidth intensityStyles
263 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 706 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
264 modifier mouseWheelScrollPage name pastableTabs path pointerBlank 707 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
265 pointerBlankDelay preeditType print_pipe pty_fd reverseVideo saveLines 708 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
266 scrollBar scrollBar_align scrollBar_floating scrollBar_right 709 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
267 scrollBar_thickness scrollTtyKeypress scrollTtyOutput scrollWithBuffer 710 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
268 scrollstyle secondaryScreen secondaryScroll selectstyle shade term_name 711 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
269 title transparent transparent_all tripleclickwords utmpInhibit 712 shade term_name title transparent transparent_all tripleclickwords
270 visualBell 713 utmpInhibit visualBell
271 714
272=cut 715=cut
273 716
274sub urxvt::term::resource($$;$) { 717sub resource($$;$) {
275 my ($self, $name) = (shift, shift); 718 my ($self, $name) = (shift, shift);
276 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 719 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
277 goto &urxvt::term::_resource; 720 &urxvt::term::_resource
278} 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).
279 732
280=item ($row, $col) = $term->selection_mark ([$row, $col]) 733=item ($row, $col) = $term->selection_mark ([$row, $col])
281 734
282=item ($row, $col) = $term->selection_beg ([$row, $col]) 735=item ($row, $col) = $term->selection_beg ([$row, $col])
283 736
293 746
294=item $oldtext = $term->selection ([$newtext]) 747=item $oldtext = $term->selection ([$newtext])
295 748
296Return the current selection text and optionally replace it by C<$newtext>. 749Return the current selection text and optionally replace it by C<$newtext>.
297 750
298=item $term->scr_overlay ($x, $y, $text) 751#=item $term->overlay ($x, $y, $text)
299 752#
300Create 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).
301 811
302=cut 812=cut
303 813
304sub urxvt::term::scr_overlay { 814sub popup {
305 my ($self, $x, $y, $text) = @_; 815 my ($self, $event) = @_;
306 816
307 my @lines = split /\n/, $text; 817 $self->grab ($event->{time}, 1)
818 or return;
308 819
309 my $w = 0; 820 my $popup = bless {
310 for (map urxvt::wcswidth $_, @lines) { 821 term => $self,
311 $w = $_ if $w < $_; 822 event => $event,
823 }, urxvt::popup::;
824
825 Scalar::Util::weaken $popup->{term};
826
827 $self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
828 Scalar::Util::weaken $self->{_destroy}{$popup};
829
830 $popup
831}
832
833=item $cellwidth = $term->strwidth ($string)
834
835Returns the number of screen-cells this string would need. Correctly
836accounts for wide and combining characters.
837
838=item $octets = $term->locale_encode ($string)
839
840Convert the given text string into the corresponding locale encoding.
841
842=item $string = $term->locale_decode ($octets)
843
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.
862
863=item $term->tt_write ($octets)
864
865Write the octets given in C<$data> to the tty (i.e. as program input). To
866pass characters instead of octets, you should convert your strings first
867to the locale-specific encoding using C<< $term->locale_encode >>.
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
887=item $terminal_rows = $term->nrow
888
889=item $terminal_columns = $term->ncol
890
891=item $has_focus = $term->focus
892
893=item $is_mapped = $term->mapped
894
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.
911
912=item $view_start = $term->view_start ([$newvalue])
913
914Returns the negative row number of the topmost line. Minimum value is
915C<0>, which displays the normal terminal contents. Larger values scroll
916this many lines into the scrollback buffer.
917
918=item $term->want_refresh
919
920Requests a screen refresh. At the next opportunity, rxvt-unicode will
921compare the on-screen display with its stored representation. If they
922differ, it redraws the differences.
923
924Used after changing terminal contents to display them.
925
926=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
927
928Returns the text of the entire row with number C<$row_number>. Row C<0>
929is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
930terminal line. The scrollback buffer starts at line C<-1> and extends to
931line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
932is requested.
933
934If C<$new_text> is specified, it will replace characters in the current
935line, starting at column C<$start_col> (default C<0>), which is useful
936to replace only parts of a line. The font index in the rendition will
937automatically be updated.
938
939C<$text> is in a special encoding: tabs and wide characters that use more
940than one cell when displayed are padded with urxvt::NOCHAR characters
941(C<chr 65535>). Characters with combining characters and other characters
942that do not fit into the normal tetx encoding will be replaced with
943characters in the private use area.
944
945You have to obey this encoding when changing text. The advantage is
946that C<substr> and similar functions work on screen cells and not on
947characters.
948
949The methods C<< $term->special_encode >> and C<< $term->special_decode >>
950can be used to convert normal strings into this encoding and vice versa.
951
952=item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
953
954Like C<< $term->ROW_t >>, but returns an arrayref with rendition
955bitsets. Rendition bitsets contain information about colour, font, font
956styles and similar information. See also C<< $term->ROW_t >>.
957
958When setting rendition, the font mask will be ignored.
959
960See the section on RENDITION, above.
961
962=item $length = $term->ROW_l ($row_number[, $new_length])
963
964Returns the number of screen cells that are in use ("the line
965length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
966line is joined with the following one.
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;
312 } 1062 }
313 1063
314 $self->scr_overlay_new ($x, $y, $w, scalar @lines); 1064 ()
315 $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
316} 1065}
317 1066
318=item $term->scr_overlay_new ($x, $y, $width, $height) 1067sub urxvt::line::beg { $_[0]{beg} }
1068sub urxvt::line::end { $_[0]{end} }
1069sub urxvt::line::l { $_[0]{len} }
319 1070
320Create a new (empty) overlay at the given position with the given 1071sub urxvt::line::offset_of {
321width/height. A border will be put around the box. If either C<$x> or 1072 my ($self, $row, $col) = @_;
322C<$y> is negative, then this is counted from the right/bottom side,
323respectively.
324 1073
325=item $term->scr_overlay_off 1074 ($row - $self->{beg}) * $self->{ncol} + $col
1075}
326 1076
327Switch the overlay off again. 1077sub urxvt::line::coord_of {
1078 my ($self, $offset) = @_;
328 1079
329=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE) 1080 use integer;
330 1081
331Put a single character (specified numerically) at the given overlay 1082 (
332position. 1083 $offset / $self->{ncol} + $self->{beg},
1084 $offset % $self->{ncol}
1085 )
1086}
333 1087
334=item $term->scr_overlay_set ($x, $y, $text) 1088=item ($row, $col) = $line->coord_of ($offset)
1089=item $text = $term->special_encode $string
335 1090
336Write a string at the given position into the overlay. 1091Converts a perl string into the special encoding used by rxvt-unicode,
1092where one character corresponds to one screen cell. See
1093C<< $term->ROW_t >> for details.
1094
1095=item $string = $term->special_decode $text
1096
1097Converts rxvt-unicodes text reprsentation into a perl string. See
1098C<< $term->ROW_t >> for details.
337 1099
338=back 1100=back
1101
1102=cut
1103
1104package urxvt::popup;
1105
1106=head2 The C<urxvt::popup> Class
1107
1108=over 4
1109
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}
339 1183
340=head2 The C<urxvt::timer> Class 1184=head2 The C<urxvt::timer> Class
341 1185
342This class implements timer watchers/events. Time is represented as a 1186This class implements timer watchers/events. Time is represented as a
343fractional number of seconds since the epoch. Example: 1187fractional number of seconds since the epoch. Example:
344 1188
345 # create a digital clock display in upper right corner 1189 $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
346 $term->{timer} = urxvt::timer 1190 $term->{timer} = urxvt::timer
347 ->new 1191 ->new
348 ->start (urxvt::NOW) 1192 ->interval (1)
349 ->cb (sub { 1193 ->cb (sub {
350 my ($timer) = @_;
351 my $time = $timer->at;
352 $timer->start ($time + 1);
353 $self->scr_overlay (-1, 0, 1194 $term->{overlay}->set (0, 0,
354 POSIX::strftime "%H:%M:%S", localtime $time); 1195 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
355 }); 1196 });
356 1197
357=over 4 1198=over 4
358 1199
359=item $timer = new urxvt::timer 1200=item $timer = new urxvt::timer
360 1201
361Create a new timer object in stopped state. 1202Create a new timer object in started state. It is scheduled to fire
1203immediately.
362 1204
363=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 1205=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
364 1206
365Set the callback to be called when the timer triggers. 1207Set the callback to be called when the timer triggers.
366 1208
369Return the time this watcher will fire next. 1211Return the time this watcher will fire next.
370 1212
371=item $timer = $timer->set ($tstamp) 1213=item $timer = $timer->set ($tstamp)
372 1214
373Set 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.
374 1222
375=item $timer = $timer->start 1223=item $timer = $timer->start
376 1224
377Start the timer. 1225Start the timer.
378 1226
441This variable controls the verbosity level of the perl extension. Higher 1289This variable controls the verbosity level of the perl extension. Higher
442numbers indicate more verbose output. 1290numbers indicate more verbose output.
443 1291
444=over 4 1292=over 4
445 1293
446=item 0 - only fatal messages 1294=item =0 - only fatal messages
447 1295
448=item 3 - script loading and management 1296=item =3 - script loading and management
449 1297
450=item 10 - all events received 1298=item =10 - all events received
451 1299
452=back 1300=back
453 1301
454=head1 AUTHOR 1302=head1 AUTHOR
455 1303

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines