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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines