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