1 |
=encoding utf8 |
2 |
|
3 |
=head1 NAME |
4 |
|
5 |
@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter |
6 |
|
7 |
=head1 SYNOPSIS |
8 |
|
9 |
# create a file grab_test in $HOME: |
10 |
|
11 |
sub on_sel_grab { |
12 |
warn "you selected ", $_[0]->selection; |
13 |
() |
14 |
} |
15 |
|
16 |
# start a @@RXVT_NAME@@ using it: |
17 |
|
18 |
@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
19 |
|
20 |
=head1 DESCRIPTION |
21 |
|
22 |
Everytime a terminal object gets created, scripts specified via the |
23 |
C<perl> resource are loaded and associated with it. |
24 |
|
25 |
Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
26 |
thus must be encoded as UTF-8. |
27 |
|
28 |
Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
29 |
scripts will be shared (but not enabled) for all terminals. |
30 |
|
31 |
=head2 Prepackaged Extensions |
32 |
|
33 |
This section describes the extensiosn delivered with this version. You can |
34 |
find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
35 |
|
36 |
You can activate them like this: |
37 |
|
38 |
@@RXVT_NAME@@ -pe <extensionname> |
39 |
|
40 |
=over 4 |
41 |
|
42 |
=item selection |
43 |
|
44 |
Intelligent selection. This extension tries to be more intelligent when |
45 |
the user extends selections (double-click). Right now, it tries to select |
46 |
urls and complete shell-quoted arguments, which is very convenient, too, |
47 |
if your F<ls> supports C<--quoting-style=shell>. |
48 |
|
49 |
It also offers the following bindable event: |
50 |
|
51 |
=over 4 |
52 |
|
53 |
=item rot13 |
54 |
|
55 |
Rot-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 digital-clock |
62 |
|
63 |
Displays a digital clock using the built-in overlay. |
64 |
|
65 |
=item example-refresh-hooks |
66 |
|
67 |
Displays a very simple digital clock in the upper right corner of the |
68 |
window. Illustrates overwriting the refresh callbacks to create your own |
69 |
overlays or changes. |
70 |
|
71 |
=back |
72 |
|
73 |
=head2 General API Considerations |
74 |
|
75 |
All objects (such as terminals, time watchers etc.) are typical |
76 |
reference-to-hash objects. The hash can be used to store anything you |
77 |
like. All members starting with an underscore (such as C<_ptr> or |
78 |
C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or |
79 |
modified). |
80 |
|
81 |
When objects are destroyed on the C++ side, the perl object hashes are |
82 |
emptied, so its best to store related objects such as time watchers and |
83 |
the like inside the terminal object so they get destroyed as soon as the |
84 |
terminal is destroyed. |
85 |
|
86 |
=head2 Hooks |
87 |
|
88 |
The following subroutines can be declared in loaded scripts, and will be |
89 |
called whenever the relevant event happens. |
90 |
|
91 |
The first argument passed to them is an object private to each terminal |
92 |
and extension package. You can call all C<urxvt::term> methods on it, but |
93 |
its not a real C<urxvt::term> object. Instead, the real C<urxvt::term> |
94 |
object that is shared between all packages is stored in the C<term> |
95 |
member. |
96 |
|
97 |
All of them must return a boolean value. If it is true, then the event |
98 |
counts as being I<consumed>, and the invocation of other hooks is skipped, |
99 |
and the relevant action might not be carried out by the C++ code. |
100 |
|
101 |
When in doubt, return a false value (preferably C<()>). |
102 |
|
103 |
=over 4 |
104 |
|
105 |
=item on_init $term |
106 |
|
107 |
Called after a new terminal object has been initialized, but before |
108 |
windows are created or the command gets run. |
109 |
|
110 |
=item on_reset $term |
111 |
|
112 |
Called after the screen is "reset" for any reason, such as resizing or |
113 |
control sequences. Here is where you can react on changes to size-related |
114 |
variables. |
115 |
|
116 |
=item on_start $term |
117 |
|
118 |
Called at the very end of initialisation of a new terminal, just before |
119 |
returning to the mainloop. |
120 |
|
121 |
=item on_sel_make $term, $eventtime |
122 |
|
123 |
Called whenever a selection has been made by the user, but before the |
124 |
selection text is copied, so changes to the beginning, end or type of the |
125 |
selection will be honored. |
126 |
|
127 |
Returning a true value aborts selection making by urxvt, in which case you |
128 |
have to make a selection yourself by calling C<< $term->selection_grab >>. |
129 |
|
130 |
=item on_sel_grab $term, $eventtime |
131 |
|
132 |
Called whenever a selection has been copied, but before the selection is |
133 |
requested from the server. The selection text can be queried and changed |
134 |
by calling C<< $term->selection >>. |
135 |
|
136 |
Returning a true value aborts selection grabbing. It will still be hilighted. |
137 |
|
138 |
=item on_sel_extend $term |
139 |
|
140 |
Called whenever the user tries to extend the selection (e.g. with a double |
141 |
click) and is either supposed to return false (normal operation), or |
142 |
should extend the selection itelf and return true to suppress the built-in |
143 |
processing. |
144 |
|
145 |
See the F<selection> example extension. |
146 |
|
147 |
=item on_focus_in $term |
148 |
|
149 |
Called whenever the window gets the keyboard focus, before urxvt does |
150 |
focus in processing. |
151 |
|
152 |
=item on_focus_out $term |
153 |
|
154 |
Called wheneever the window loses keyboard focus, before urxvt does focus |
155 |
out processing. |
156 |
|
157 |
=item on_view_change $term, $offset |
158 |
|
159 |
Called whenever the view offset changes, i..e the user or program |
160 |
scrolls. Offset C<0> means display the normal terminal, positive values |
161 |
show this many lines of scrollback. |
162 |
|
163 |
=item on_scroll_back $term, $lines, $saved |
164 |
|
165 |
Called whenever lines scroll out of the terminal area into the scrollback |
166 |
buffer. C<$lines> is the number of lines scrolled out and may be larger |
167 |
than the scroll back buffer or the terminal. |
168 |
|
169 |
It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
170 |
$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
171 |
number of lines that will be in the scrollback buffer. |
172 |
|
173 |
=item on_tty_activity $term *NYI* |
174 |
|
175 |
Called whenever the program(s) running in the urxvt window send output. |
176 |
|
177 |
=item on_osc_seq $term, $string |
178 |
|
179 |
Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
180 |
operating system command) is processed. Cursor position and other state |
181 |
information is up-to-date when this happens. For interoperability, the |
182 |
string should start with the extension name and a colon, to distinguish |
183 |
it from commands for other extensions, and this might be enforced in the |
184 |
future. |
185 |
|
186 |
Be careful not ever to trust (in a security sense) the data you receive, |
187 |
as its source can not easily be controleld (e-mail content, messages from |
188 |
other users on the same system etc.). |
189 |
|
190 |
=item on_refresh_begin $term |
191 |
|
192 |
Called just before the screen gets redrawn. Can be used for overlay |
193 |
or similar effects by modify terminal contents in refresh_begin, and |
194 |
restoring them in refresh_end. The built-in overlay and selection display |
195 |
code is run after this hook, and takes precedence. |
196 |
|
197 |
=item on_refresh_end $term |
198 |
|
199 |
Called just after the screen gets redrawn. See C<on_refresh_begin>. |
200 |
|
201 |
=item on_keyboard_command $term, $string |
202 |
|
203 |
Called whenever the user presses a key combination that has a |
204 |
C<perl:string> action bound to it (see description of the B<keysym> |
205 |
resource in the @@RXVT_NAME@@(1) manpage). |
206 |
|
207 |
=back |
208 |
|
209 |
=head2 Variables in the C<urxvt> Package |
210 |
|
211 |
=over 4 |
212 |
|
213 |
=item $urxvt::TERM |
214 |
|
215 |
The current terminal. Whenever a callback/Hook is bein executed, this |
216 |
variable stores the current C<urxvt::term> object. |
217 |
|
218 |
=back |
219 |
|
220 |
=head2 Functions in the C<urxvt> Package |
221 |
|
222 |
=over 4 |
223 |
|
224 |
=item urxvt::fatal $errormessage |
225 |
|
226 |
Fatally aborts execution with the given error message. Avoid at all |
227 |
costs! The only time this is acceptable is when the terminal process |
228 |
starts up. |
229 |
|
230 |
=item urxvt::warn $string |
231 |
|
232 |
Calls C<rxvt_warn> with the given string which should not include a |
233 |
newline. The module also overwrites the C<warn> builtin with a function |
234 |
that calls this function. |
235 |
|
236 |
Using this function has the advantage that its output ends up in the |
237 |
correct place, e.g. on stderr of the connecting urxvtc client. |
238 |
|
239 |
=item $time = urxvt::NOW |
240 |
|
241 |
Returns the "current time" (as per the event loop). |
242 |
|
243 |
=back |
244 |
|
245 |
=head2 RENDITION |
246 |
|
247 |
Rendition bitsets contain information about colour, font, font styles and |
248 |
similar information for each screen cell. |
249 |
|
250 |
The following "macros" deal with changes in rendition sets. You should |
251 |
never just create a bitset, you should always modify an existing one, |
252 |
as they contain important information required for correct operation of |
253 |
rxvt-unicode. |
254 |
|
255 |
=over 4 |
256 |
|
257 |
=item $rend = urxvt::DEFAULT_RSTYLE |
258 |
|
259 |
Returns the default rendition, as used when the terminal is starting up or |
260 |
being reset. Useful as a base to start when creating renditions. |
261 |
|
262 |
=item $rend = urxvt::OVERLAY_RSTYLE |
263 |
|
264 |
Return the rendition mask used for overlays by default. |
265 |
|
266 |
=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline |
267 |
|
268 |
Return the bit that enabled bold, italic, blink, reverse-video and |
269 |
underline, respectively. To enable such a style, just logically OR it into |
270 |
the bitset. |
271 |
|
272 |
=item $foreground = urxvt::GET_BASEFG $rend |
273 |
|
274 |
=item $background = urxvt::GET_BASEBG $rend |
275 |
|
276 |
Return the foreground/background colour index, respectively. |
277 |
|
278 |
=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) |
279 |
|
280 |
=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) |
281 |
|
282 |
Replace the foreground/background colour in the rendition mask with the |
283 |
specified one. |
284 |
|
285 |
=item $value = urxvt::GET_CUSTOM ($rend) |
286 |
|
287 |
Return the "custom" value: Every rendition has 5 bits for use by |
288 |
extensions. They can be set and changed as you like and are initially |
289 |
zero. |
290 |
|
291 |
=item $rend = urxvt::SET_CUSTOM ($rend, $new_value) |
292 |
|
293 |
Change the custom value. |
294 |
|
295 |
=back |
296 |
|
297 |
=cut |
298 |
|
299 |
package urxvt; |
300 |
|
301 |
use strict; |
302 |
use Scalar::Util (); |
303 |
|
304 |
our $TERM; |
305 |
our @HOOKNAME; |
306 |
our $LIBDIR; |
307 |
|
308 |
BEGIN { |
309 |
urxvt->bootstrap; |
310 |
|
311 |
# overwrite perl's warn |
312 |
*CORE::GLOBAL::warn = sub { |
313 |
my $msg = join "", @_; |
314 |
$msg .= "\n" |
315 |
unless $msg =~ /\n$/; |
316 |
urxvt::warn ($msg); |
317 |
}; |
318 |
} |
319 |
|
320 |
my @hook_count; |
321 |
my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
322 |
|
323 |
sub verbose { |
324 |
my ($level, $msg) = @_; |
325 |
warn "$msg\n" if $level <= $verbosity; |
326 |
} |
327 |
|
328 |
# find on_xxx subs in the package and register them |
329 |
# as hooks |
330 |
sub register_package($) { |
331 |
my ($pkg) = @_; |
332 |
|
333 |
for my $htype (0.. $#HOOKNAME) { |
334 |
my $name = $HOOKNAME[$htype]; |
335 |
|
336 |
my $ref = $pkg->can ("on_" . lc $name) |
337 |
or next; |
338 |
|
339 |
$TERM->{_hook}[$htype]{$pkg} = $ref; |
340 |
$hook_count[$htype]++ |
341 |
or set_should_invoke $htype, 1; |
342 |
} |
343 |
} |
344 |
|
345 |
my $script_pkg = "script0000"; |
346 |
my %script_pkg; |
347 |
|
348 |
# load a single script into its own package, once only |
349 |
sub script_package($) { |
350 |
my ($path) = @_; |
351 |
|
352 |
$script_pkg{$path} ||= do { |
353 |
my $pkg = "urxvt::" . ($script_pkg++); |
354 |
|
355 |
verbose 3, "loading script '$path' into package '$pkg'"; |
356 |
|
357 |
open my $fh, "<:raw", $path |
358 |
or die "$path: $!"; |
359 |
|
360 |
my $source = "package $pkg; use strict; use utf8;\n" |
361 |
. "#line 1 \"$path\"\n{\n" |
362 |
. (do { local $/; <$fh> }) |
363 |
. "\n};\n1"; |
364 |
|
365 |
eval $source or die "$path: $@"; |
366 |
|
367 |
$pkg |
368 |
} |
369 |
} |
370 |
|
371 |
# called by the rxvt core |
372 |
sub invoke { |
373 |
local $TERM = shift; |
374 |
my $htype = shift; |
375 |
|
376 |
if ($htype == 0) { # INIT |
377 |
my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
378 |
|
379 |
for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
380 |
my @files = grep -f $_, map "$_/$ext", @dirs; |
381 |
|
382 |
if (@files) { |
383 |
register_package script_package $files[0]; |
384 |
} else { |
385 |
warn "perl extension '$ext' not found in perl library search path\n"; |
386 |
} |
387 |
} |
388 |
|
389 |
} elsif ($htype == 1) { # DESTROY |
390 |
if (my $hook = $TERM->{_hook}) { |
391 |
for my $htype (0..$#$hook) { |
392 |
$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
393 |
or set_should_invoke $htype, 0; |
394 |
} |
395 |
} |
396 |
} |
397 |
|
398 |
my $cb = $TERM->{_hook}[$htype] |
399 |
or return; |
400 |
|
401 |
verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
402 |
if $verbosity >= 10; |
403 |
|
404 |
keys %$cb; |
405 |
|
406 |
while (my ($pkg, $cb) = each %$cb) { |
407 |
return 1 |
408 |
if $cb->( |
409 |
$TERM->{$pkg} ||= do { |
410 |
my $proxy = bless { }, urxvt::term::proxy::; |
411 |
Scalar::Util::weaken ($proxy->{term} = $TERM); |
412 |
$proxy |
413 |
}, |
414 |
@_, |
415 |
); |
416 |
} |
417 |
|
418 |
0 |
419 |
} |
420 |
|
421 |
sub urxvt::term::proxy::AUTOLOAD { |
422 |
$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ |
423 |
or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; |
424 |
|
425 |
eval qq{ |
426 |
sub $urxvt::term::proxy::AUTOLOAD { |
427 |
my \$proxy = shift; |
428 |
\$proxy->{term}->$1 (\@_) |
429 |
} |
430 |
1 |
431 |
} or die "FATAL: unable to compile method forwarder: $@"; |
432 |
|
433 |
goto &$urxvt::term::proxy::AUTOLOAD; |
434 |
} |
435 |
|
436 |
=head2 The C<urxvt::term> Class |
437 |
|
438 |
=over 4 |
439 |
|
440 |
=item $value = $term->resource ($name[, $newval]) |
441 |
|
442 |
Returns the current resource value associated with a given name and |
443 |
optionally sets a new value. Setting values is most useful in the C<init> |
444 |
hook. Unset resources are returned and accepted as C<undef>. |
445 |
|
446 |
The new value must be properly encoded to a suitable character encoding |
447 |
before passing it to this method. Similarly, the returned value may need |
448 |
to be converted from the used encoding to text. |
449 |
|
450 |
Resource names are as defined in F<src/rsinc.h>. Colours can be specified |
451 |
as resource names of the form C<< color+<index> >>, e.g. C<color+5>. (will |
452 |
likely change). |
453 |
|
454 |
Please note that resource strings will currently only be freed when the |
455 |
terminal is destroyed, so changing options frequently will eat memory. |
456 |
|
457 |
Here is a a likely non-exhaustive list of resource names, not all of which |
458 |
are supported in every build, please see the source to see the actual |
459 |
list: |
460 |
|
461 |
answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
462 |
borderLess color cursorBlink cursorUnderline cutchars delete_key |
463 |
display_name embed ext_bwidth fade font geometry hold iconName |
464 |
imFont imLocale inputMethod insecure int_bwidth intensityStyles |
465 |
italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
466 |
mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
467 |
perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
468 |
reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
469 |
scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
470 |
scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
471 |
shade term_name title transparent transparent_all tripleclickwords |
472 |
utmpInhibit visualBell |
473 |
|
474 |
=cut |
475 |
|
476 |
sub urxvt::term::resource($$;$) { |
477 |
my ($self, $name) = (shift, shift); |
478 |
unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
479 |
goto &urxvt::term::_resource; |
480 |
} |
481 |
|
482 |
=item ($row, $col) = $term->selection_mark ([$row, $col]) |
483 |
|
484 |
=item ($row, $col) = $term->selection_beg ([$row, $col]) |
485 |
|
486 |
=item ($row, $col) = $term->selection_end ([$row, $col]) |
487 |
|
488 |
Return the current values of the selection mark, begin or end positions, |
489 |
and optionally set them to new values. |
490 |
|
491 |
=item $success = $term->selection_grab ($eventtime) |
492 |
|
493 |
Try to request the primary selection from the server (for example, as set |
494 |
by the next method). |
495 |
|
496 |
=item $oldtext = $term->selection ([$newtext]) |
497 |
|
498 |
Return the current selection text and optionally replace it by C<$newtext>. |
499 |
|
500 |
#=item $term->overlay ($x, $y, $text) |
501 |
# |
502 |
#Create a simple multi-line overlay box. See the next method for details. |
503 |
# |
504 |
#=cut |
505 |
|
506 |
sub urxvt::term::scr_overlay { |
507 |
die; |
508 |
my ($self, $x, $y, $text) = @_; |
509 |
|
510 |
my @lines = split /\n/, $text; |
511 |
|
512 |
my $w = 0; |
513 |
for (map $self->strwidth ($_), @lines) { |
514 |
$w = $_ if $w < $_; |
515 |
} |
516 |
|
517 |
$self->scr_overlay_new ($x, $y, $w, scalar @lines); |
518 |
$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
519 |
} |
520 |
|
521 |
=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
522 |
|
523 |
Create a new (empty) overlay at the given position with the given |
524 |
width/height. C<$rstyle> defines the initial rendition style |
525 |
(default: C<OVERLAY_RSTYLE>). |
526 |
|
527 |
If C<$border> is C<2> (default), then a decorative border will be put |
528 |
around the box. |
529 |
|
530 |
If either C<$x> or C<$y> is negative, then this is counted from the |
531 |
right/bottom side, respectively. |
532 |
|
533 |
This method returns an urxvt::overlay object. The overlay will be visible |
534 |
as long as the perl object is referenced. |
535 |
|
536 |
The methods currently supported on C<urxvt::overlay> objects are: |
537 |
|
538 |
=over 4 |
539 |
|
540 |
=item $overlay->set ($x, $y, $text, $rend) |
541 |
|
542 |
Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
543 |
text in rxvt-unicode's special encoding and an array of rendition values |
544 |
at a specific position inside the overlay. |
545 |
|
546 |
=item $overlay->hide |
547 |
|
548 |
If visible, hide the overlay, but do not destroy it. |
549 |
|
550 |
=item $overlay->show |
551 |
|
552 |
If hidden, display the overlay again. |
553 |
|
554 |
=back |
555 |
|
556 |
=item $cellwidth = $term->strwidth $string |
557 |
|
558 |
Returns the number of screen-cells this string would need. Correctly |
559 |
accounts for wide and combining characters. |
560 |
|
561 |
=item $octets = $term->locale_encode $string |
562 |
|
563 |
Convert the given text string into the corresponding locale encoding. |
564 |
|
565 |
=item $string = $term->locale_decode $octets |
566 |
|
567 |
Convert the given locale-encoded octets into a perl string. |
568 |
|
569 |
=item $term->tt_write ($octets) |
570 |
|
571 |
Write the octets given in C<$data> to the tty (i.e. as program input). To |
572 |
pass characters instead of octets, you should convert your strings first |
573 |
to the locale-specific encoding using C<< $term->locale_encode >>. |
574 |
|
575 |
=item $nrow = $term->nrow |
576 |
|
577 |
=item $ncol = $term->ncol |
578 |
|
579 |
Return the number of rows/columns of the terminal window (i.e. as |
580 |
specified by C<-geometry>, excluding any scrollback). |
581 |
|
582 |
=item $nsaved = $term->nsaved |
583 |
|
584 |
Returns the number of lines in the scrollback buffer. |
585 |
|
586 |
=item $view_start = $term->view_start ([$newvalue]) |
587 |
|
588 |
Returns the negative row number of the topmost line. Minimum value is |
589 |
C<0>, which displays the normal terminal contents. Larger values scroll |
590 |
this many lines into the scrollback buffer. |
591 |
|
592 |
=item $term->want_refresh |
593 |
|
594 |
Requests a screen refresh. At the next opportunity, rxvt-unicode will |
595 |
compare the on-screen display with its stored representation. If they |
596 |
differ, it redraws the differences. |
597 |
|
598 |
Used after changing terminal contents to display them. |
599 |
|
600 |
=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
601 |
|
602 |
Returns the text of the entire row with number C<$row_number>. Row C<0> |
603 |
is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost |
604 |
terminal line. The scrollback buffer starts at line C<-1> and extends to |
605 |
line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line |
606 |
is requested. |
607 |
|
608 |
If C<$new_text> is specified, it will replace characters in the current |
609 |
line, starting at column C<$start_col> (default C<0>), which is useful |
610 |
to replace only parts of a line. The font index in the rendition will |
611 |
automatically be updated. |
612 |
|
613 |
C<$text> is in a special encoding: tabs and wide characters that use more |
614 |
than one cell when displayed are padded with urxvt::NOCHAR characters |
615 |
(C<chr 65535>). Characters with combining characters and other characters |
616 |
that do not fit into the normal tetx encoding will be replaced with |
617 |
characters in the private use area. |
618 |
|
619 |
You have to obey this encoding when changing text. The advantage is |
620 |
that C<substr> and similar functions work on screen cells and not on |
621 |
characters. |
622 |
|
623 |
The methods C<< $term->special_encode >> and C<< $term->special_decode >> |
624 |
can be used to convert normal strings into this encoding and vice versa. |
625 |
|
626 |
=item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]]) |
627 |
|
628 |
Like C<< $term->ROW_t >>, but returns an arrayref with rendition |
629 |
bitsets. Rendition bitsets contain information about colour, font, font |
630 |
styles and similar information. See also C<< $term->ROW_t >>. |
631 |
|
632 |
When setting rendition, the font mask will be ignored. |
633 |
|
634 |
See the section on RENDITION, above. |
635 |
|
636 |
=item $length = $term->ROW_l ($row_number[, $new_length]) |
637 |
|
638 |
Returns the number of screen cells that are in use ("the line |
639 |
length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the |
640 |
line is joined with the following one. |
641 |
|
642 |
=item $bool = $term->is_longer ($row_number) |
643 |
|
644 |
Returns true if the row is part of a multiple-row logical "line" (i.e. |
645 |
joined with the following row), which means all characters are in use |
646 |
and it is continued on the next row (and possibly a continuation of the |
647 |
previous row(s)). |
648 |
|
649 |
=item $line = $term->line ($row_number) |
650 |
|
651 |
Create and return a new C<urxvt::line> object that stores information |
652 |
about the logical line that row C<$row_number> is part of. It supports the |
653 |
following methods: |
654 |
|
655 |
=over 4 |
656 |
|
657 |
=item $text = $line->t |
658 |
|
659 |
Returns the full text of the line, similar to C<ROW_t> |
660 |
|
661 |
=item $rend = $line->r |
662 |
|
663 |
Returns the full rendition array of the line, similar to C<ROW_r> |
664 |
|
665 |
=item $length = $line->l |
666 |
|
667 |
Returns the length of the line in cells, similar to C<ROW_l>. |
668 |
|
669 |
=item $rownum = $line->beg |
670 |
|
671 |
=item $rownum = $line->end |
672 |
|
673 |
Return the row number of the first/last row of the line, respectively. |
674 |
|
675 |
=item $offset = $line->offset_of ($row, $col) |
676 |
|
677 |
Returns the character offset of the given row|col pair within the logical |
678 |
line. |
679 |
|
680 |
=item ($row, $col) = $line->coord_of ($offset) |
681 |
|
682 |
Translates a string offset into terminal coordinates again. |
683 |
|
684 |
=back |
685 |
|
686 |
=cut |
687 |
|
688 |
sub urxvt::term::line { |
689 |
my ($self, $row) = @_; |
690 |
|
691 |
my $maxrow = $self->nrow - 1; |
692 |
|
693 |
my ($beg, $end) = ($row, $row); |
694 |
|
695 |
--$beg while $self->ROW_is_longer ($beg - 1); |
696 |
++$end while $self->ROW_is_longer ($end) && $end < $maxrow; |
697 |
|
698 |
bless { |
699 |
term => $self, |
700 |
beg => $beg, |
701 |
end => $end, |
702 |
len => ($end - $beg) * $self->ncol + $self->ROW_l ($end), |
703 |
}, urxvt::line:: |
704 |
} |
705 |
|
706 |
sub urxvt::line::t { |
707 |
my ($self) = @_; |
708 |
|
709 |
substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
710 |
0, $self->{len} |
711 |
} |
712 |
|
713 |
sub urxvt::line::r { |
714 |
my ($self) = @_; |
715 |
|
716 |
my $rend = [ |
717 |
map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
718 |
]; |
719 |
$#$rend = $self->{len} - 1; |
720 |
$rend |
721 |
} |
722 |
|
723 |
sub urxvt::line::beg { $_[0]{beg} } |
724 |
sub urxvt::line::end { $_[0]{end} } |
725 |
sub urxvt::line::l { $_[0]{len} } |
726 |
|
727 |
sub urxvt::line::offset_of { |
728 |
my ($self, $row, $col) = @_; |
729 |
|
730 |
($row - $self->{beg}) * $self->{term}->ncol + $col |
731 |
} |
732 |
|
733 |
sub urxvt::line::coord_of { |
734 |
my ($self, $offset) = @_; |
735 |
|
736 |
use integer; |
737 |
|
738 |
( |
739 |
$offset / $self->{term}->ncol + $self->{beg}, |
740 |
$offset % $self->{term}->ncol |
741 |
) |
742 |
} |
743 |
|
744 |
=item ($row, $col) = $line->coord_of ($offset) |
745 |
=item $text = $term->special_encode $string |
746 |
|
747 |
Converts a perl string into the special encoding used by rxvt-unicode, |
748 |
where one character corresponds to one screen cell. See |
749 |
C<< $term->ROW_t >> for details. |
750 |
|
751 |
=item $string = $term->special_decode $text |
752 |
|
753 |
Converts rxvt-unicodes text reprsentation into a perl string. See |
754 |
C<< $term->ROW_t >> for details. |
755 |
|
756 |
=back |
757 |
|
758 |
=head2 The C<urxvt::timer> Class |
759 |
|
760 |
This class implements timer watchers/events. Time is represented as a |
761 |
fractional number of seconds since the epoch. Example: |
762 |
|
763 |
$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); |
764 |
$term->{timer} = urxvt::timer |
765 |
->new |
766 |
->interval (1) |
767 |
->cb (sub { |
768 |
$term->{overlay}->set (0, 0, |
769 |
sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
770 |
}); |
771 |
|
772 |
=over 4 |
773 |
|
774 |
=item $timer = new urxvt::timer |
775 |
|
776 |
Create a new timer object in started state. It is scheduled to fire |
777 |
immediately. |
778 |
|
779 |
=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
780 |
|
781 |
Set the callback to be called when the timer triggers. |
782 |
|
783 |
=item $tstamp = $timer->at |
784 |
|
785 |
Return the time this watcher will fire next. |
786 |
|
787 |
=item $timer = $timer->set ($tstamp) |
788 |
|
789 |
Set the time the event is generated to $tstamp. |
790 |
|
791 |
=item $timer = $timer->interval ($interval) |
792 |
|
793 |
Normally (and when C<$interval> is C<0>), the timer will automatically |
794 |
stop after it has fired once. If C<$interval> is non-zero, then the timer |
795 |
is automatically rescheduled at the given intervals. |
796 |
|
797 |
=item $timer = $timer->start |
798 |
|
799 |
Start the timer. |
800 |
|
801 |
=item $timer = $timer->start ($tstamp) |
802 |
|
803 |
Set the event trigger time to C<$tstamp> and start the timer. |
804 |
|
805 |
=item $timer = $timer->stop |
806 |
|
807 |
Stop the timer. |
808 |
|
809 |
=back |
810 |
|
811 |
=head2 The C<urxvt::iow> Class |
812 |
|
813 |
This class implements io watchers/events. Example: |
814 |
|
815 |
$term->{socket} = ... |
816 |
$term->{iow} = urxvt::iow |
817 |
->new |
818 |
->fd (fileno $term->{socket}) |
819 |
->events (1) # wait for read data |
820 |
->start |
821 |
->cb (sub { |
822 |
my ($iow, $revents) = @_; |
823 |
# $revents must be 1 here, no need to check |
824 |
sysread $term->{socket}, my $buf, 8192 |
825 |
or end-of-file; |
826 |
}); |
827 |
|
828 |
|
829 |
=over 4 |
830 |
|
831 |
=item $iow = new urxvt::iow |
832 |
|
833 |
Create a new io watcher object in stopped state. |
834 |
|
835 |
=item $iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... }) |
836 |
|
837 |
Set the callback to be called when io events are triggered. C<$reventmask> |
838 |
is a bitset as described in the C<events> method. |
839 |
|
840 |
=item $iow = $iow->fd ($fd) |
841 |
|
842 |
Set the filedescriptor (not handle) to watch. |
843 |
|
844 |
=item $iow = $iow->events ($eventmask) |
845 |
|
846 |
Set the event mask to watch. Bit #0 (value C<1>) enables watching for read |
847 |
data, Bit #1 (value C<2>) enables watching for write data. |
848 |
|
849 |
=item $iow = $iow->start |
850 |
|
851 |
Start watching for requested events on the given handle. |
852 |
|
853 |
=item $iow = $iow->stop |
854 |
|
855 |
Stop watching for events on the given filehandle. |
856 |
|
857 |
=back |
858 |
|
859 |
=head1 ENVIRONMENT |
860 |
|
861 |
=head2 URXVT_PERL_VERBOSITY |
862 |
|
863 |
This variable controls the verbosity level of the perl extension. Higher |
864 |
numbers indicate more verbose output. |
865 |
|
866 |
=over 4 |
867 |
|
868 |
=item =0 - only fatal messages |
869 |
|
870 |
=item =3 - script loading and management |
871 |
|
872 |
=item =10 - all events received |
873 |
|
874 |
=back |
875 |
|
876 |
=head1 AUTHOR |
877 |
|
878 |
Marc Lehmann <pcg@goof.com> |
879 |
http://software.schmorp.de/pkg/rxvt-unicode |
880 |
|
881 |
=cut |
882 |
|
883 |
1 |