… | |
… | |
17 | |
17 | |
18 | @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
18 | @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
19 | |
19 | |
20 | =head1 DESCRIPTION |
20 | =head1 DESCRIPTION |
21 | |
21 | |
22 | Everytime a terminal object gets created, scripts specified via the |
22 | Everytime a terminal object gets created, extension scripts specified via |
23 | C<perl> resource are loaded and associated with it. |
23 | the C<perl> resource are loaded and associated with it. |
24 | |
24 | |
25 | Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
25 | Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
26 | thus must be encoded as UTF-8. |
26 | thus must be encoded as UTF-8. |
27 | |
27 | |
28 | Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
28 | Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
… | |
… | |
59 | =back |
59 | =back |
60 | |
60 | |
61 | =item digital-clock |
61 | =item digital-clock |
62 | |
62 | |
63 | Displays a digital clock using the built-in overlay. |
63 | Displays a digital clock using the built-in overlay. |
|
|
64 | |
|
|
65 | =item mark-urls |
|
|
66 | |
|
|
67 | Uses per-line display filtering (C<on_line_update>) to underline urls. |
|
|
68 | |
|
|
69 | =item block-graphics-to-ascii |
|
|
70 | |
|
|
71 | A not very useful example of filtering all text output to the terminal, |
|
|
72 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
|
|
73 | similar-looking ascii character. |
64 | |
74 | |
65 | =item example-refresh-hooks |
75 | =item example-refresh-hooks |
66 | |
76 | |
67 | Displays a very simple digital clock in the upper right corner of the |
77 | Displays a very simple digital clock in the upper right corner of the |
68 | window. Illustrates overwriting the refresh callbacks to create your own |
78 | window. Illustrates overwriting the refresh callbacks to create your own |
… | |
… | |
81 | When objects are destroyed on the C++ side, the perl object hashes are |
91 | 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 |
92 | 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 |
93 | the like inside the terminal object so they get destroyed as soon as the |
84 | terminal is destroyed. |
94 | terminal is destroyed. |
85 | |
95 | |
|
|
96 | Argument names also often indicate the type of a parameter. Here are some |
|
|
97 | hints on what they mean: |
|
|
98 | |
|
|
99 | =over 4 |
|
|
100 | |
|
|
101 | =item $text |
|
|
102 | |
|
|
103 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
|
|
104 | always represents one screen cell. See L<row_t> for a discussion of this format. |
|
|
105 | |
|
|
106 | =item $string |
|
|
107 | |
|
|
108 | A perl text string, with an emphasis on I<text>. It can store all unicode |
|
|
109 | characters and is to be distinguished with text encoded in a specific |
|
|
110 | encoding (often locale-specific) and binary data. |
|
|
111 | |
|
|
112 | =item $octets |
|
|
113 | |
|
|
114 | Either binary data or - more common - a text string encoded in a |
|
|
115 | locale-specific way. |
|
|
116 | |
|
|
117 | =back |
|
|
118 | |
86 | =head2 Hooks |
119 | =head2 Hooks |
87 | |
120 | |
88 | The following subroutines can be declared in loaded scripts, and will be |
121 | The following subroutines can be declared in extension files, and will be |
89 | called whenever the relevant event happens. |
122 | called whenever the relevant event happens. |
90 | |
123 | |
91 | The first argument passed to them is an object private to each terminal |
124 | 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 |
125 | 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> |
126 | 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> |
127 | object that is shared between all packages is stored in the C<term> |
95 | member. |
128 | member. It is, however, blessed intot he package of the extension script, |
|
|
129 | so for all practical purposes you can treat an extension script as a class. |
96 | |
130 | |
97 | All of them must return a boolean value. If it is true, then the event |
131 | 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, |
132 | 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. |
133 | and the relevant action might not be carried out by the C++ code. |
100 | |
134 | |
… | |
… | |
103 | =over 4 |
137 | =over 4 |
104 | |
138 | |
105 | =item on_init $term |
139 | =item on_init $term |
106 | |
140 | |
107 | Called after a new terminal object has been initialized, but before |
141 | Called after a new terminal object has been initialized, but before |
108 | windows are created or the command gets run. |
142 | windows are created or the command gets run. Most methods are unsafe to |
|
|
143 | call or deliver senseless data, as terminal size and other characteristics |
|
|
144 | have not yet been determined. You can safely query and change resources, |
|
|
145 | though. |
109 | |
146 | |
110 | =item on_reset $term |
147 | =item on_reset $term |
111 | |
148 | |
112 | Called after the screen is "reset" for any reason, such as resizing or |
149 | 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 |
150 | control sequences. Here is where you can react on changes to size-related |
… | |
… | |
142 | should extend the selection itelf and return true to suppress the built-in |
179 | should extend the selection itelf and return true to suppress the built-in |
143 | processing. |
180 | processing. |
144 | |
181 | |
145 | See the F<selection> example extension. |
182 | See the F<selection> example extension. |
146 | |
183 | |
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 |
184 | =item on_view_change $term, $offset |
158 | |
185 | |
159 | Called whenever the view offset changes, i..e the user or program |
186 | Called whenever the view offset changes, i..e the user or program |
160 | scrolls. Offset C<0> means display the normal terminal, positive values |
187 | scrolls. Offset C<0> means display the normal terminal, positive values |
161 | show this many lines of scrollback. |
188 | show this many lines of scrollback. |
… | |
… | |
174 | |
201 | |
175 | Called whenever the program(s) running in the urxvt window send output. |
202 | Called whenever the program(s) running in the urxvt window send output. |
176 | |
203 | |
177 | =item on_osc_seq $term, $string |
204 | =item on_osc_seq $term, $string |
178 | |
205 | |
179 | Called whenever the B<ESC ] 777 ; string ST> command sequence is |
206 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
180 | processed. Cursor position and other state information is up-to-date when |
207 | operating system command) is processed. Cursor position and other state |
181 | this happens. For interoperability, the string should start with the |
208 | information is up-to-date when this happens. For interoperability, the |
182 | extension name and a colon, to distinguish it from commands for other |
209 | string should start with the extension name and a colon, to distinguish |
183 | extensions, and this might be enforced in the future. |
210 | it from commands for other extensions, and this might be enforced in the |
|
|
211 | future. |
|
|
212 | |
|
|
213 | Be careful not ever to trust (in a security sense) the data you receive, |
|
|
214 | as its source can not easily be controleld (e-mail content, messages from |
|
|
215 | other users on the same system etc.). |
|
|
216 | |
|
|
217 | =item on_add_lines $term, $string |
|
|
218 | |
|
|
219 | Called whenever text is about to be output, with the text as argument. You |
|
|
220 | can filter/change and output the text yourself by returning a true value |
|
|
221 | and calling C<< $term->scr_add_lines >> yourself. Please note that this |
|
|
222 | might be very slow, however, as your hook is called for B<all> text being |
|
|
223 | output. |
|
|
224 | |
|
|
225 | =item on_line_update $term, $row |
|
|
226 | |
|
|
227 | Called whenever a line was updated or changed. Can be used to filter |
|
|
228 | screen output (e.g. underline urls or other useless stuff). Only lines |
|
|
229 | that are being shown will be filtered, and, due to performance reasons, |
|
|
230 | not always immediately. |
|
|
231 | |
|
|
232 | The row number is always the topmost row of the line if the line spans |
|
|
233 | multiple rows. |
|
|
234 | |
|
|
235 | Please note that, if you change the line, then the hook might get called |
|
|
236 | later with the already-modified line (e.g. if unrelated parts change), so |
|
|
237 | you cannot just toggle rendition bits, but only set them. |
184 | |
238 | |
185 | =item on_refresh_begin $term |
239 | =item on_refresh_begin $term |
186 | |
240 | |
187 | Called just before the screen gets redrawn. Can be used for overlay |
241 | Called just before the screen gets redrawn. Can be used for overlay |
188 | or similar effects by modify terminal contents in refresh_begin, and |
242 | or similar effects by modify terminal contents in refresh_begin, and |
… | |
… | |
197 | |
251 | |
198 | Called whenever the user presses a key combination that has a |
252 | Called whenever the user presses a key combination that has a |
199 | C<perl:string> action bound to it (see description of the B<keysym> |
253 | C<perl:string> action bound to it (see description of the B<keysym> |
200 | resource in the @@RXVT_NAME@@(1) manpage). |
254 | resource in the @@RXVT_NAME@@(1) manpage). |
201 | |
255 | |
|
|
256 | =item on_focus_in $term |
|
|
257 | |
|
|
258 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
|
|
259 | does focus in processing. |
|
|
260 | |
|
|
261 | =item on_focus_out $term |
|
|
262 | |
|
|
263 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
|
|
264 | focus out processing. |
|
|
265 | |
|
|
266 | =item on_key_press $term, $event, $octets |
|
|
267 | |
|
|
268 | =item on_key_release $term, $event |
|
|
269 | |
|
|
270 | =item on_button_press $term, $event |
|
|
271 | |
|
|
272 | =item on_button_release $term, $event |
|
|
273 | |
|
|
274 | =item on_motion_notify $term, $event |
|
|
275 | |
|
|
276 | =item on_map_notify $term, $event |
|
|
277 | |
|
|
278 | =item on_unmap_notify $term, $event |
|
|
279 | |
|
|
280 | Called whenever the corresponding X event is received for the terminal If |
|
|
281 | the hook returns true, then the even will be ignored by rxvt-unicode. |
|
|
282 | |
|
|
283 | The event is a hash with most values as named by Xlib (see the XEvent |
|
|
284 | manpage), with the additional members C<row> and C<col>, which are the row |
|
|
285 | and column under the mouse cursor. |
|
|
286 | |
|
|
287 | C<on_key_press> additionally receives the string rxvt-unicode would |
|
|
288 | output, if any, in locale-specific encoding. |
|
|
289 | |
|
|
290 | subwindow. |
|
|
291 | |
202 | =back |
292 | =back |
203 | |
293 | |
204 | =head2 Variables in the C<urxvt> Package |
294 | =head2 Variables in the C<urxvt> Package |
205 | |
295 | |
206 | =over 4 |
296 | =over 4 |
207 | |
297 | |
208 | =item $urxvt::TERM |
298 | =item $urxvt::TERM |
209 | |
299 | |
210 | The current terminal. Whenever a callback/Hook is bein executed, this |
300 | The current terminal. This variable stores the current C<urxvt::term> |
211 | variable stores the current C<urxvt::term> object. |
301 | object, whenever a callback/hook is executing. |
212 | |
302 | |
213 | =back |
303 | =back |
214 | |
304 | |
215 | =head2 Functions in the C<urxvt> Package |
305 | =head2 Functions in the C<urxvt> Package |
216 | |
306 | |
217 | =over 4 |
307 | =over 4 |
|
|
308 | |
|
|
309 | =item $term = new urxvt [arg...] |
|
|
310 | |
|
|
311 | Creates a new terminal, very similar as if you had started it with |
|
|
312 | C<system $binfile, arg...>. Croaks (and probably outputs an error message) |
|
|
313 | if the new instance couldn't be created. Returns C<undef> if the new |
|
|
314 | instance didn't initialise perl, and the terminal object otherwise. The |
|
|
315 | C<init> and C<start> hooks will be called during the call. |
218 | |
316 | |
219 | =item urxvt::fatal $errormessage |
317 | =item urxvt::fatal $errormessage |
220 | |
318 | |
221 | Fatally aborts execution with the given error message. Avoid at all |
319 | Fatally aborts execution with the given error message. Avoid at all |
222 | costs! The only time this is acceptable is when the terminal process |
320 | costs! The only time this is acceptable is when the terminal process |
… | |
… | |
232 | correct place, e.g. on stderr of the connecting urxvtc client. |
330 | correct place, e.g. on stderr of the connecting urxvtc client. |
233 | |
331 | |
234 | =item $time = urxvt::NOW |
332 | =item $time = urxvt::NOW |
235 | |
333 | |
236 | Returns the "current time" (as per the event loop). |
334 | Returns the "current time" (as per the event loop). |
|
|
335 | |
|
|
336 | =item urxvt::CurrentTime |
|
|
337 | |
|
|
338 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
|
|
339 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
|
|
340 | Button4Mask, Button5Mask, AnyModifier |
|
|
341 | |
|
|
342 | Various constants for use in X events. |
237 | |
343 | |
238 | =back |
344 | =back |
239 | |
345 | |
240 | =head2 RENDITION |
346 | =head2 RENDITION |
241 | |
347 | |
… | |
… | |
335 | $hook_count[$htype]++ |
441 | $hook_count[$htype]++ |
336 | or set_should_invoke $htype, 1; |
442 | or set_should_invoke $htype, 1; |
337 | } |
443 | } |
338 | } |
444 | } |
339 | |
445 | |
340 | my $script_pkg = "script0000"; |
446 | my $extension_pkg = "extension0000"; |
341 | my %script_pkg; |
447 | my %extension_pkg; |
342 | |
448 | |
343 | # load a single script into its own package, once only |
449 | # load a single script into its own package, once only |
344 | sub script_package($) { |
450 | sub extension_package($) { |
345 | my ($path) = @_; |
451 | my ($path) = @_; |
346 | |
452 | |
347 | $script_pkg{$path} ||= do { |
453 | $extension_pkg{$path} ||= do { |
348 | my $pkg = "urxvt::" . ($script_pkg++); |
454 | my $pkg = "urxvt::" . ($extension_pkg++); |
349 | |
455 | |
350 | verbose 3, "loading script '$path' into package '$pkg'"; |
456 | verbose 3, "loading extension '$path' into package '$pkg'"; |
351 | |
457 | |
352 | open my $fh, "<:raw", $path |
458 | open my $fh, "<:raw", $path |
353 | or die "$path: $!"; |
459 | or die "$path: $!"; |
354 | |
460 | |
355 | my $source = "package $pkg; use strict; use utf8;\n" |
461 | my $source = "package $pkg; use strict; use utf8;\n" |
|
|
462 | . "use base urxvt::term::proxy::;\n" |
356 | . "#line 1 \"$path\"\n{\n" |
463 | . "#line 1 \"$path\"\n{\n" |
357 | . (do { local $/; <$fh> }) |
464 | . (do { local $/; <$fh> }) |
358 | . "\n};\n1"; |
465 | . "\n};\n1"; |
359 | |
466 | |
360 | eval $source or die "$path: $@"; |
467 | eval $source or die "$path: $@"; |
361 | |
468 | |
362 | $pkg |
469 | $pkg |
363 | } |
470 | } |
364 | } |
471 | } |
|
|
472 | |
|
|
473 | our $retval; # return value for urxvt |
365 | |
474 | |
366 | # called by the rxvt core |
475 | # called by the rxvt core |
367 | sub invoke { |
476 | sub invoke { |
368 | local $TERM = shift; |
477 | local $TERM = shift; |
369 | my $htype = shift; |
478 | my $htype = shift; |
370 | |
479 | |
371 | if ($htype == 0) { # INIT |
480 | if ($htype == 0) { # INIT |
372 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
481 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
373 | |
482 | |
374 | for my $ext (split /:/, $TERM->resource ("perl_ext")) { |
483 | for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
375 | my @files = grep -f $_, map "$_/$ext", @dirs; |
484 | my @files = grep -f $_, map "$_/$ext", @dirs; |
376 | |
485 | |
377 | if (@files) { |
486 | if (@files) { |
378 | register_package script_package $files[0]; |
487 | register_package extension_package $files[0]; |
379 | } else { |
488 | } else { |
380 | warn "perl extension '$ext' not found in perl library search path\n"; |
489 | warn "perl extension '$ext' not found in perl library search path\n"; |
381 | } |
490 | } |
382 | } |
491 | } |
|
|
492 | } |
383 | |
493 | |
|
|
494 | $retval = undef; |
|
|
495 | |
|
|
496 | if (my $cb = $TERM->{_hook}[$htype]) { |
|
|
497 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
|
|
498 | if $verbosity >= 10; |
|
|
499 | |
|
|
500 | keys %$cb; |
|
|
501 | |
|
|
502 | while (my ($pkg, $cb) = each %$cb) { |
|
|
503 | eval { |
|
|
504 | $retval = $cb->( |
|
|
505 | $TERM->{_pkg}{$pkg} ||= do { |
|
|
506 | my $proxy = bless { }, $pkg; |
|
|
507 | Scalar::Util::weaken ($proxy->{term} = $TERM); |
|
|
508 | $proxy |
|
|
509 | }, |
|
|
510 | @_, |
|
|
511 | ) and last; |
|
|
512 | }; |
|
|
513 | warn $@ if $@;#d# |
|
|
514 | } |
|
|
515 | } |
|
|
516 | |
384 | } elsif ($htype == 1) { # DESTROY |
517 | if ($htype == 1) { # DESTROY |
|
|
518 | # remove hooks if unused |
385 | if (my $hook = $TERM->{_hook}) { |
519 | if (my $hook = $TERM->{_hook}) { |
386 | for my $htype (0..$#$hook) { |
520 | for my $htype (0..$#$hook) { |
387 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
521 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
388 | or set_should_invoke $htype, 0; |
522 | or set_should_invoke $htype, 0; |
389 | } |
523 | } |
390 | } |
524 | } |
|
|
525 | |
|
|
526 | # clear package objects |
|
|
527 | %$_ = () for values %{ $TERM->{_pkg} }; |
|
|
528 | |
|
|
529 | # clear package |
|
|
530 | %$TERM = (); |
391 | } |
531 | } |
392 | |
532 | |
393 | my $cb = $TERM->{_hook}[$htype] |
533 | $retval |
394 | or return; |
|
|
395 | |
|
|
396 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
|
|
397 | if $verbosity >= 10; |
|
|
398 | |
|
|
399 | keys %$cb; |
|
|
400 | |
|
|
401 | while (my ($pkg, $cb) = each %$cb) { |
|
|
402 | return 1 |
|
|
403 | if $cb->( |
|
|
404 | $TERM->{$pkg} ||= do { |
|
|
405 | my $proxy = bless { }, urxvt::term::proxy::; |
|
|
406 | Scalar::Util::weaken ($proxy->{term} = $TERM); |
|
|
407 | $proxy |
|
|
408 | }, |
|
|
409 | @_, |
|
|
410 | ); |
|
|
411 | } |
|
|
412 | |
|
|
413 | 0 |
|
|
414 | } |
534 | } |
415 | |
535 | |
416 | sub urxvt::term::proxy::AUTOLOAD { |
536 | sub urxvt::term::proxy::AUTOLOAD { |
417 | $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ |
537 | $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ |
418 | or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; |
538 | or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; |
… | |
… | |
426 | } or die "FATAL: unable to compile method forwarder: $@"; |
546 | } or die "FATAL: unable to compile method forwarder: $@"; |
427 | |
547 | |
428 | goto &$urxvt::term::proxy::AUTOLOAD; |
548 | goto &$urxvt::term::proxy::AUTOLOAD; |
429 | } |
549 | } |
430 | |
550 | |
|
|
551 | sub urxvt::destroy_hook::DESTROY { |
|
|
552 | ${$_[0]}->(); |
|
|
553 | } |
|
|
554 | |
|
|
555 | sub urxvt::destroy_hook(&) { |
|
|
556 | bless \shift, urxvt::destroy_hook:: |
|
|
557 | } |
|
|
558 | |
431 | =head2 The C<urxvt::term> Class |
559 | =head2 The C<urxvt::term> Class |
432 | |
560 | |
433 | =over 4 |
561 | =over 4 |
|
|
562 | |
|
|
563 | =item $term->destroy |
|
|
564 | |
|
|
565 | Destroy the terminal object (close the window, free resources etc.). |
434 | |
566 | |
435 | =item $value = $term->resource ($name[, $newval]) |
567 | =item $value = $term->resource ($name[, $newval]) |
436 | |
568 | |
437 | Returns the current resource value associated with a given name and |
569 | Returns the current resource value associated with a given name and |
438 | optionally sets a new value. Setting values is most useful in the C<init> |
570 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
456 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
588 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
457 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
589 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
458 | display_name embed ext_bwidth fade font geometry hold iconName |
590 | display_name embed ext_bwidth fade font geometry hold iconName |
459 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
591 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
460 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
592 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
461 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext |
593 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
462 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
594 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
463 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
595 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
464 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
596 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
465 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
597 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
466 | shade term_name title transparent transparent_all tripleclickwords |
598 | shade term_name title transparent transparent_all tripleclickwords |
… | |
… | |
469 | =cut |
601 | =cut |
470 | |
602 | |
471 | sub urxvt::term::resource($$;$) { |
603 | sub urxvt::term::resource($$;$) { |
472 | my ($self, $name) = (shift, shift); |
604 | my ($self, $name) = (shift, shift); |
473 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
605 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
474 | goto &urxvt::term::_resource; |
606 | &urxvt::term::_resource |
475 | } |
607 | } |
|
|
608 | |
|
|
609 | =item $rend = $term->rstyle ([$new_rstyle]) |
|
|
610 | |
|
|
611 | Return and optionally change the current rendition. Text that is output by |
|
|
612 | the terminal application will use this style. |
|
|
613 | |
|
|
614 | =item ($row, $col) = $term->screen_cur ([$row, $col]) |
|
|
615 | |
|
|
616 | Return the current coordinates of the text cursor position and optionally |
|
|
617 | set it (which is usually bad as applications don't expect that). |
476 | |
618 | |
477 | =item ($row, $col) = $term->selection_mark ([$row, $col]) |
619 | =item ($row, $col) = $term->selection_mark ([$row, $col]) |
478 | |
620 | |
479 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
621 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
480 | |
622 | |
… | |
… | |
495 | #=item $term->overlay ($x, $y, $text) |
637 | #=item $term->overlay ($x, $y, $text) |
496 | # |
638 | # |
497 | #Create a simple multi-line overlay box. See the next method for details. |
639 | #Create a simple multi-line overlay box. See the next method for details. |
498 | # |
640 | # |
499 | #=cut |
641 | #=cut |
500 | |
642 | # |
501 | sub urxvt::term::scr_overlay { |
643 | #sub urxvt::term::scr_overlay { |
502 | die; |
|
|
503 | my ($self, $x, $y, $text) = @_; |
644 | # my ($self, $x, $y, $text) = @_; |
504 | |
645 | # |
505 | my @lines = split /\n/, $text; |
646 | # my @lines = split /\n/, $text; |
506 | |
647 | # |
507 | my $w = 0; |
648 | # my $w = 0; |
508 | for (map $self->strwidth ($_), @lines) { |
649 | # for (map $self->strwidth ($_), @lines) { |
509 | $w = $_ if $w < $_; |
650 | # $w = $_ if $w < $_; |
510 | } |
651 | # } |
511 | |
652 | # |
512 | $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
653 | # $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
513 | $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
654 | # $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
514 | } |
655 | #} |
515 | |
656 | |
516 | =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
657 | =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
517 | |
658 | |
518 | Create a new (empty) overlay at the given position with the given |
659 | Create a new (empty) overlay at the given position with the given |
519 | width/height. C<$rstyle> defines the initial rendition style |
660 | width/height. C<$rstyle> defines the initial rendition style |
… | |
… | |
546 | |
687 | |
547 | If hidden, display the overlay again. |
688 | If hidden, display the overlay again. |
548 | |
689 | |
549 | =back |
690 | =back |
550 | |
691 | |
|
|
692 | =item $popup = $term->popup ($event) |
|
|
693 | |
|
|
694 | Creates a new C<urxvt::popup> object that implements a popup menu. The |
|
|
695 | C<$event> I<must> be the event causing the menu to pop up (a button event, |
|
|
696 | currently). |
|
|
697 | |
|
|
698 | =cut |
|
|
699 | |
|
|
700 | sub urxvt::term::popup { |
|
|
701 | my ($self, $event) = @_; |
|
|
702 | |
|
|
703 | $self->grab ($event->{time}, 1) |
|
|
704 | or return; |
|
|
705 | |
|
|
706 | my $popup = bless { |
|
|
707 | term => $self, |
|
|
708 | event => $event, |
|
|
709 | }, urxvt::popup::; |
|
|
710 | |
|
|
711 | Scalar::Util::weaken $popup->{term}; |
|
|
712 | |
|
|
713 | $self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy }; |
|
|
714 | Scalar::Util::weaken $self->{_destroy}{$popup}; |
|
|
715 | |
|
|
716 | $popup |
|
|
717 | } |
|
|
718 | |
551 | =item $cellwidth = $term->strwidth $string |
719 | =item $cellwidth = $term->strwidth ($string) |
552 | |
720 | |
553 | Returns the number of screen-cells this string would need. Correctly |
721 | Returns the number of screen-cells this string would need. Correctly |
554 | accounts for wide and combining characters. |
722 | accounts for wide and combining characters. |
555 | |
723 | |
556 | =item $octets = $term->locale_encode $string |
724 | =item $octets = $term->locale_encode ($string) |
557 | |
725 | |
558 | Convert the given text string into the corresponding locale encoding. |
726 | Convert the given text string into the corresponding locale encoding. |
559 | |
727 | |
560 | =item $string = $term->locale_decode $octets |
728 | =item $string = $term->locale_decode ($octets) |
561 | |
729 | |
562 | Convert the given locale-encoded octets into a perl string. |
730 | Convert the given locale-encoded octets into a perl string. |
|
|
731 | |
|
|
732 | =item $term->scr_add_lines ($string) |
|
|
733 | |
|
|
734 | Write the given text string to the screen, as if output by the application |
|
|
735 | running inside the terminal. It may not contain command sequences (escape |
|
|
736 | codes), but is free to use line feeds, carriage returns and tabs. The |
|
|
737 | string is a normal text string, not in locale-dependent encoding. |
|
|
738 | |
|
|
739 | Normally its not a good idea to use this function, as programs might be |
|
|
740 | confused by changes in cursor position or scrolling. Its useful inside a |
|
|
741 | C<on_add_lines> hook, though. |
|
|
742 | |
|
|
743 | =item $term->cmd_parse ($octets) |
|
|
744 | |
|
|
745 | Similar to C<scr_add_lines>, but the argument must be in the |
|
|
746 | locale-specific encoding of the terminal and can contain command sequences |
|
|
747 | (escape codes) that will be interpreted. |
563 | |
748 | |
564 | =item $term->tt_write ($octets) |
749 | =item $term->tt_write ($octets) |
565 | |
750 | |
566 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
751 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
567 | pass characters instead of octets, you should convert your strings first |
752 | pass characters instead of octets, you should convert your strings first |
568 | to the locale-specific encoding using C<< $term->locale_encode >>. |
753 | to the locale-specific encoding using C<< $term->locale_encode >>. |
569 | |
754 | |
|
|
755 | =item $windowid = $term->parent |
|
|
756 | |
|
|
757 | Return the window id of the toplevel window. |
|
|
758 | |
|
|
759 | =item $windowid = $term->vt |
|
|
760 | |
|
|
761 | Return the window id of the terminal window. |
|
|
762 | |
|
|
763 | =item $window_width = $term->width |
|
|
764 | |
|
|
765 | =item $window_height = $term->height |
|
|
766 | |
|
|
767 | =item $font_width = $term->fwidth |
|
|
768 | |
|
|
769 | =item $font_height = $term->fheight |
|
|
770 | |
|
|
771 | =item $font_ascent = $term->fbase |
|
|
772 | |
570 | =item $nrow = $term->nrow |
773 | =item $terminal_rows = $term->nrow |
571 | |
774 | |
572 | =item $ncol = $term->ncol |
775 | =item $terminal_columns = $term->ncol |
573 | |
776 | |
574 | Return the number of rows/columns of the terminal window (i.e. as |
777 | =item $has_focus = $term->focus |
575 | specified by C<-geometry>, excluding any scrollback). |
|
|
576 | |
778 | |
577 | =item $nsaved = $term->nsaved |
779 | =item $is_mapped = $term->mapped |
578 | |
780 | |
579 | Returns the number of lines in the scrollback buffer. |
781 | =item $max_scrollback = $term->saveLines |
|
|
782 | |
|
|
783 | =item $nrow_plus_saveLines = $term->total_rows |
|
|
784 | |
|
|
785 | =item $lines_in_scrollback = $term->nsaved |
|
|
786 | |
|
|
787 | Return various integers describing terminal characteristics. |
|
|
788 | |
|
|
789 | =item $modifiermask = $term->ModLevel3Mask |
|
|
790 | |
|
|
791 | =item $modifiermask = $term->ModMetaMask |
|
|
792 | |
|
|
793 | =item $modifiermask = $term->ModNumLockMask |
|
|
794 | |
|
|
795 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
|
|
796 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
580 | |
797 | |
581 | =item $view_start = $term->view_start ([$newvalue]) |
798 | =item $view_start = $term->view_start ([$newvalue]) |
582 | |
799 | |
583 | Returns the negative row number of the topmost line. Minimum value is |
800 | Returns the negative row number of the topmost line. Minimum value is |
584 | C<0>, which displays the normal terminal contents. Larger values scroll |
801 | C<0>, which displays the normal terminal contents. Larger values scroll |
… | |
… | |
647 | about the logical line that row C<$row_number> is part of. It supports the |
864 | about the logical line that row C<$row_number> is part of. It supports the |
648 | following methods: |
865 | following methods: |
649 | |
866 | |
650 | =over 4 |
867 | =over 4 |
651 | |
868 | |
652 | =item $text = $line->t |
869 | =item $text = $line->t ([$new_text]) |
653 | |
870 | |
654 | Returns the full text of the line, similar to C<ROW_t> |
871 | Returns or replaces the full text of the line, similar to C<ROW_t> |
655 | |
872 | |
656 | =item $rend = $line->r |
873 | =item $rend = $line->r ([$new_rend]) |
657 | |
874 | |
658 | Returns the full rendition array of the line, similar to C<ROW_r> |
875 | Returns or replaces the full rendition array of the line, similar to C<ROW_r> |
659 | |
876 | |
660 | =item $length = $line->l |
877 | =item $length = $line->l |
661 | |
878 | |
662 | Returns the length of the line in cells, similar to C<ROW_l>. |
879 | Returns the length of the line in cells, similar to C<ROW_l>. |
663 | |
880 | |
… | |
… | |
692 | |
909 | |
693 | bless { |
910 | bless { |
694 | term => $self, |
911 | term => $self, |
695 | beg => $beg, |
912 | beg => $beg, |
696 | end => $end, |
913 | end => $end, |
|
|
914 | ncol => $self->ncol, |
697 | len => ($end - $beg) * $self->ncol + $self->ROW_l ($end), |
915 | len => ($end - $beg) * $self->ncol + $self->ROW_l ($end), |
698 | }, urxvt::line:: |
916 | }, urxvt::line:: |
699 | } |
917 | } |
700 | |
918 | |
701 | sub urxvt::line::t { |
919 | sub urxvt::line::t { |
702 | my ($self) = @_; |
920 | my ($self) = @_; |
703 | |
921 | |
|
|
922 | if (@_ > 1) |
|
|
923 | { |
|
|
924 | $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
|
|
925 | for $self->{beg} .. $self->{end}; |
|
|
926 | } |
|
|
927 | |
|
|
928 | defined wantarray && |
704 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
929 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
705 | 0, $self->{len} |
930 | 0, $self->{len} |
706 | } |
931 | } |
707 | |
932 | |
708 | sub urxvt::line::r { |
933 | sub urxvt::line::r { |
709 | my ($self) = @_; |
934 | my ($self) = @_; |
710 | |
935 | |
|
|
936 | if (@_ > 1) |
|
|
937 | { |
|
|
938 | $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
|
|
939 | for $self->{beg} .. $self->{end}; |
|
|
940 | } |
|
|
941 | |
|
|
942 | if (defined wantarray) { |
711 | my $rend = [ |
943 | my $rend = [ |
712 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
944 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
713 | ]; |
945 | ]; |
714 | $#$rend = $self->{len} - 1; |
946 | $#$rend = $self->{len} - 1; |
715 | $rend |
947 | return $rend; |
|
|
948 | } |
|
|
949 | |
|
|
950 | () |
716 | } |
951 | } |
717 | |
952 | |
718 | sub urxvt::line::beg { $_[0]{beg} } |
953 | sub urxvt::line::beg { $_[0]{beg} } |
719 | sub urxvt::line::end { $_[0]{end} } |
954 | sub urxvt::line::end { $_[0]{end} } |
720 | sub urxvt::line::l { $_[0]{len} } |
955 | sub urxvt::line::l { $_[0]{len} } |
721 | |
956 | |
722 | sub urxvt::line::offset_of { |
957 | sub urxvt::line::offset_of { |
723 | my ($self, $row, $col) = @_; |
958 | my ($self, $row, $col) = @_; |
724 | |
959 | |
725 | ($row - $self->{beg}) * $self->{term}->ncol + $col |
960 | ($row - $self->{beg}) * $self->{ncol} + $col |
726 | } |
961 | } |
727 | |
962 | |
728 | sub urxvt::line::coord_of { |
963 | sub urxvt::line::coord_of { |
729 | my ($self, $offset) = @_; |
964 | my ($self, $offset) = @_; |
730 | |
965 | |
731 | use integer; |
966 | use integer; |
732 | |
967 | |
733 | ( |
968 | ( |
734 | $offset / $self->{term}->ncol + $self->{beg}, |
969 | $offset / $self->{ncol} + $self->{beg}, |
735 | $offset % $self->{term}->ncol |
970 | $offset % $self->{ncol} |
736 | ) |
971 | ) |
737 | } |
972 | } |
738 | |
973 | |
739 | =item ($row, $col) = $line->coord_of ($offset) |
974 | =item ($row, $col) = $line->coord_of ($offset) |
740 | =item $text = $term->special_encode $string |
975 | =item $text = $term->special_encode $string |
… | |
… | |
747 | |
982 | |
748 | Converts rxvt-unicodes text reprsentation into a perl string. See |
983 | Converts rxvt-unicodes text reprsentation into a perl string. See |
749 | C<< $term->ROW_t >> for details. |
984 | C<< $term->ROW_t >> for details. |
750 | |
985 | |
751 | =back |
986 | =back |
|
|
987 | |
|
|
988 | =head2 The C<urxvt::popup> Class |
|
|
989 | |
|
|
990 | =over 4 |
|
|
991 | |
|
|
992 | =cut |
|
|
993 | |
|
|
994 | package urxvt::popup; |
|
|
995 | |
|
|
996 | sub add_item { |
|
|
997 | my ($self, $item) = @_; |
|
|
998 | |
|
|
999 | push @{ $self->{item} }, $item; |
|
|
1000 | } |
|
|
1001 | |
|
|
1002 | sub add_button { |
|
|
1003 | my ($self, $text, $cb) = @_; |
|
|
1004 | |
|
|
1005 | $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb }); |
|
|
1006 | } |
|
|
1007 | |
|
|
1008 | sub show { |
|
|
1009 | my ($self) = @_; |
|
|
1010 | |
|
|
1011 | local $urxvt::popup::self = $self; |
|
|
1012 | |
|
|
1013 | urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
|
|
1014 | "--transient-for" => $self->{term}->parent, |
|
|
1015 | "-pe" => "urxvt-popup") |
|
|
1016 | or die "unable to create popup window\n"; |
|
|
1017 | } |
|
|
1018 | |
|
|
1019 | sub DESTROY { |
|
|
1020 | my ($self) = @_; |
|
|
1021 | |
|
|
1022 | $self->{term}->ungrab; |
|
|
1023 | } |
752 | |
1024 | |
753 | =head2 The C<urxvt::timer> Class |
1025 | =head2 The C<urxvt::timer> Class |
754 | |
1026 | |
755 | This class implements timer watchers/events. Time is represented as a |
1027 | This class implements timer watchers/events. Time is represented as a |
756 | fractional number of seconds since the epoch. Example: |
1028 | fractional number of seconds since the epoch. Example: |