… | |
… | |
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 |
… | |
… | |
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 | |
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. |
|
|
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 |
69 | overlays or changes. |
79 | overlays or changes. |
70 | |
|
|
71 | =item mark-urls |
|
|
72 | |
|
|
73 | A not very useful example of filtering all text output to the terminal, by |
|
|
74 | underlining all urls that matches a certain regex (i.e. some urls :). It |
|
|
75 | is not very useful because urls that are output in multiple steps (e.g. |
|
|
76 | when typing them) do not get marked. |
|
|
77 | |
80 | |
78 | =back |
81 | =back |
79 | |
82 | |
80 | =head2 General API Considerations |
83 | =head2 General API Considerations |
81 | |
84 | |
… | |
… | |
113 | |
116 | |
114 | =back |
117 | =back |
115 | |
118 | |
116 | =head2 Hooks |
119 | =head2 Hooks |
117 | |
120 | |
118 | 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 |
119 | called whenever the relevant event happens. |
122 | called whenever the relevant event happens. |
120 | |
123 | |
121 | 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 |
122 | 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 |
123 | 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> |
124 | 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> |
125 | 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. |
126 | |
130 | |
127 | 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 |
128 | 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, |
129 | 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. |
130 | |
134 | |
… | |
… | |
133 | =over 4 |
137 | =over 4 |
134 | |
138 | |
135 | =item on_init $term |
139 | =item on_init $term |
136 | |
140 | |
137 | Called after a new terminal object has been initialized, but before |
141 | Called after a new terminal object has been initialized, but before |
138 | 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. |
139 | |
146 | |
140 | =item on_reset $term |
147 | =item on_reset $term |
141 | |
148 | |
142 | 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 |
143 | 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 |
… | |
… | |
171 | click) and is either supposed to return false (normal operation), or |
178 | click) and is either supposed to return false (normal operation), or |
172 | 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 |
173 | processing. |
180 | processing. |
174 | |
181 | |
175 | See the F<selection> example extension. |
182 | See the F<selection> example extension. |
176 | |
|
|
177 | =item on_focus_in $term |
|
|
178 | |
|
|
179 | Called whenever the window gets the keyboard focus, before urxvt does |
|
|
180 | focus in processing. |
|
|
181 | |
|
|
182 | =item on_focus_out $term |
|
|
183 | |
|
|
184 | Called wheneever the window loses keyboard focus, before urxvt does focus |
|
|
185 | out processing. |
|
|
186 | |
183 | |
187 | =item on_view_change $term, $offset |
184 | =item on_view_change $term, $offset |
188 | |
185 | |
189 | 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 |
190 | scrolls. Offset C<0> means display the normal terminal, positive values |
187 | scrolls. Offset C<0> means display the normal terminal, positive values |
… | |
… | |
223 | can filter/change and output the text yourself by returning a true value |
220 | can filter/change and output the text yourself by returning a true value |
224 | and calling C<< $term->scr_add_lines >> yourself. Please note that this |
221 | and calling C<< $term->scr_add_lines >> yourself. Please note that this |
225 | might be very slow, however, as your hook is called for B<all> text being |
222 | might be very slow, however, as your hook is called for B<all> text being |
226 | output. |
223 | output. |
227 | |
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. |
|
|
238 | |
228 | =item on_refresh_begin $term |
239 | =item on_refresh_begin $term |
229 | |
240 | |
230 | 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 |
231 | or similar effects by modify terminal contents in refresh_begin, and |
242 | or similar effects by modify terminal contents in refresh_begin, and |
232 | restoring them in refresh_end. The built-in overlay and selection display |
243 | restoring them in refresh_end. The built-in overlay and selection display |
… | |
… | |
240 | |
251 | |
241 | Called whenever the user presses a key combination that has a |
252 | Called whenever the user presses a key combination that has a |
242 | 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> |
243 | resource in the @@RXVT_NAME@@(1) manpage). |
254 | resource in the @@RXVT_NAME@@(1) manpage). |
244 | |
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 | |
245 | =back |
292 | =back |
246 | |
293 | |
247 | =head2 Variables in the C<urxvt> Package |
294 | =head2 Variables in the C<urxvt> Package |
248 | |
295 | |
249 | =over 4 |
296 | =over 4 |
250 | |
297 | |
251 | =item $urxvt::TERM |
298 | =item $urxvt::TERM |
252 | |
299 | |
253 | The current terminal. Whenever a callback/Hook is bein executed, this |
300 | The current terminal. This variable stores the current C<urxvt::term> |
254 | variable stores the current C<urxvt::term> object. |
301 | object, whenever a callback/hook is executing. |
255 | |
302 | |
256 | =back |
303 | =back |
257 | |
304 | |
258 | =head2 Functions in the C<urxvt> Package |
305 | =head2 Functions in the C<urxvt> Package |
259 | |
306 | |
260 | =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. |
261 | |
316 | |
262 | =item urxvt::fatal $errormessage |
317 | =item urxvt::fatal $errormessage |
263 | |
318 | |
264 | Fatally aborts execution with the given error message. Avoid at all |
319 | Fatally aborts execution with the given error message. Avoid at all |
265 | 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 |
… | |
… | |
275 | correct place, e.g. on stderr of the connecting urxvtc client. |
330 | correct place, e.g. on stderr of the connecting urxvtc client. |
276 | |
331 | |
277 | =item $time = urxvt::NOW |
332 | =item $time = urxvt::NOW |
278 | |
333 | |
279 | 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. |
280 | |
343 | |
281 | =back |
344 | =back |
282 | |
345 | |
283 | =head2 RENDITION |
346 | =head2 RENDITION |
284 | |
347 | |
… | |
… | |
334 | |
397 | |
335 | =cut |
398 | =cut |
336 | |
399 | |
337 | package urxvt; |
400 | package urxvt; |
338 | |
401 | |
|
|
402 | use utf8; |
339 | use strict; |
403 | use strict; |
340 | use Scalar::Util (); |
404 | use Scalar::Util (); |
|
|
405 | use List::Util (); |
341 | |
406 | |
342 | our $TERM; |
407 | our $TERM; |
343 | our @HOOKNAME; |
408 | our @HOOKNAME; |
344 | our $LIBDIR; |
409 | our $LIBDIR; |
345 | |
410 | |
… | |
… | |
378 | $hook_count[$htype]++ |
443 | $hook_count[$htype]++ |
379 | or set_should_invoke $htype, 1; |
444 | or set_should_invoke $htype, 1; |
380 | } |
445 | } |
381 | } |
446 | } |
382 | |
447 | |
383 | my $script_pkg = "script0000"; |
448 | my $extension_pkg = "extension0000"; |
384 | my %script_pkg; |
449 | my %extension_pkg; |
385 | |
450 | |
386 | # load a single script into its own package, once only |
451 | # load a single script into its own package, once only |
387 | sub script_package($) { |
452 | sub extension_package($) { |
388 | my ($path) = @_; |
453 | my ($path) = @_; |
389 | |
454 | |
390 | $script_pkg{$path} ||= do { |
455 | $extension_pkg{$path} ||= do { |
391 | my $pkg = "urxvt::" . ($script_pkg++); |
456 | my $pkg = "urxvt::" . ($extension_pkg++); |
392 | |
457 | |
393 | verbose 3, "loading script '$path' into package '$pkg'"; |
458 | verbose 3, "loading extension '$path' into package '$pkg'"; |
394 | |
459 | |
395 | open my $fh, "<:raw", $path |
460 | open my $fh, "<:raw", $path |
396 | or die "$path: $!"; |
461 | or die "$path: $!"; |
397 | |
462 | |
398 | my $source = "package $pkg; use strict; use utf8;\n" |
463 | my $source = "package $pkg; use strict; use utf8;\n" |
|
|
464 | . "use base urxvt::term::proxy::;\n" |
399 | . "#line 1 \"$path\"\n{\n" |
465 | . "#line 1 \"$path\"\n{\n" |
400 | . (do { local $/; <$fh> }) |
466 | . (do { local $/; <$fh> }) |
401 | . "\n};\n1"; |
467 | . "\n};\n1"; |
402 | |
468 | |
403 | eval $source or die "$path: $@"; |
469 | eval $source or die "$path: $@"; |
… | |
… | |
414 | my $htype = shift; |
480 | my $htype = shift; |
415 | |
481 | |
416 | if ($htype == 0) { # INIT |
482 | if ($htype == 0) { # INIT |
417 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
483 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
418 | |
484 | |
419 | for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
485 | for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
420 | my @files = grep -f $_, map "$_/$ext", @dirs; |
486 | my @files = grep -f $_, map "$_/$ext", @dirs; |
421 | |
487 | |
422 | if (@files) { |
488 | if (@files) { |
423 | register_package script_package $files[0]; |
489 | register_package extension_package $files[0]; |
424 | } else { |
490 | } else { |
425 | warn "perl extension '$ext' not found in perl library search path\n"; |
491 | warn "perl extension '$ext' not found in perl library search path\n"; |
426 | } |
492 | } |
427 | } |
493 | } |
428 | } |
494 | } |
… | |
… | |
434 | if $verbosity >= 10; |
500 | if $verbosity >= 10; |
435 | |
501 | |
436 | keys %$cb; |
502 | keys %$cb; |
437 | |
503 | |
438 | while (my ($pkg, $cb) = each %$cb) { |
504 | while (my ($pkg, $cb) = each %$cb) { |
|
|
505 | eval { |
439 | $retval = $cb->( |
506 | $retval = $cb->( |
440 | $TERM->{_pkg}{$pkg} ||= do { |
507 | $TERM->{_pkg}{$pkg} ||= do { |
441 | my $proxy = bless { }, urxvt::term::proxy::; |
508 | my $proxy = bless { }, $pkg; |
442 | Scalar::Util::weaken ($proxy->{term} = $TERM); |
509 | Scalar::Util::weaken ($proxy->{term} = $TERM); |
443 | $proxy |
510 | $proxy |
444 | }, |
511 | }, |
445 | @_, |
512 | @_, |
446 | ) and last; |
513 | ) and last; |
|
|
514 | }; |
|
|
515 | warn $@ if $@;#d# |
447 | } |
516 | } |
448 | } |
517 | } |
449 | |
518 | |
450 | if ($htype == 1) { # DESTROY |
519 | if ($htype == 1) { # DESTROY |
451 | # remove hooks if unused |
520 | # remove hooks if unused |
… | |
… | |
479 | } or die "FATAL: unable to compile method forwarder: $@"; |
548 | } or die "FATAL: unable to compile method forwarder: $@"; |
480 | |
549 | |
481 | goto &$urxvt::term::proxy::AUTOLOAD; |
550 | goto &$urxvt::term::proxy::AUTOLOAD; |
482 | } |
551 | } |
483 | |
552 | |
|
|
553 | sub urxvt::destroy_hook::DESTROY { |
|
|
554 | ${$_[0]}->(); |
|
|
555 | } |
|
|
556 | |
|
|
557 | sub urxvt::destroy_hook(&) { |
|
|
558 | bless \shift, urxvt::destroy_hook:: |
|
|
559 | } |
|
|
560 | |
484 | =head2 The C<urxvt::term> Class |
561 | =head2 The C<urxvt::term> Class |
485 | |
562 | |
486 | =over 4 |
563 | =over 4 |
|
|
564 | |
|
|
565 | =item $term->destroy |
|
|
566 | |
|
|
567 | Destroy the terminal object (close the window, free resources etc.). |
487 | |
568 | |
488 | =item $value = $term->resource ($name[, $newval]) |
569 | =item $value = $term->resource ($name[, $newval]) |
489 | |
570 | |
490 | Returns the current resource value associated with a given name and |
571 | Returns the current resource value associated with a given name and |
491 | optionally sets a new value. Setting values is most useful in the C<init> |
572 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
522 | =cut |
603 | =cut |
523 | |
604 | |
524 | sub urxvt::term::resource($$;$) { |
605 | sub urxvt::term::resource($$;$) { |
525 | my ($self, $name) = (shift, shift); |
606 | my ($self, $name) = (shift, shift); |
526 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
607 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
527 | goto &urxvt::term::_resource; |
608 | &urxvt::term::_resource |
528 | } |
609 | } |
529 | |
610 | |
530 | =item $rend = $term->rstyle ([$new_rstyle]) |
611 | =item $rend = $term->rstyle ([$new_rstyle]) |
531 | |
612 | |
532 | Return and optionally change the current rendition. Text that is output by |
613 | Return and optionally change the current rendition. Text that is output by |
… | |
… | |
608 | |
689 | |
609 | If hidden, display the overlay again. |
690 | If hidden, display the overlay again. |
610 | |
691 | |
611 | =back |
692 | =back |
612 | |
693 | |
|
|
694 | =item $popup = $term->popup ($event) |
|
|
695 | |
|
|
696 | Creates a new C<urxvt::popup> object that implements a popup menu. The |
|
|
697 | C<$event> I<must> be the event causing the menu to pop up (a button event, |
|
|
698 | currently). |
|
|
699 | |
|
|
700 | =cut |
|
|
701 | |
|
|
702 | sub urxvt::term::popup { |
|
|
703 | my ($self, $event) = @_; |
|
|
704 | |
|
|
705 | $self->grab ($event->{time}, 1) |
|
|
706 | or return; |
|
|
707 | |
|
|
708 | my $popup = bless { |
|
|
709 | term => $self, |
|
|
710 | event => $event, |
|
|
711 | }, urxvt::popup::; |
|
|
712 | |
|
|
713 | Scalar::Util::weaken $popup->{term}; |
|
|
714 | |
|
|
715 | $self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy }; |
|
|
716 | Scalar::Util::weaken $self->{_destroy}{$popup}; |
|
|
717 | |
|
|
718 | $popup |
|
|
719 | } |
|
|
720 | |
613 | =item $cellwidth = $term->strwidth $string |
721 | =item $cellwidth = $term->strwidth ($string) |
614 | |
722 | |
615 | Returns the number of screen-cells this string would need. Correctly |
723 | Returns the number of screen-cells this string would need. Correctly |
616 | accounts for wide and combining characters. |
724 | accounts for wide and combining characters. |
617 | |
725 | |
618 | =item $octets = $term->locale_encode $string |
726 | =item $octets = $term->locale_encode ($string) |
619 | |
727 | |
620 | Convert the given text string into the corresponding locale encoding. |
728 | Convert the given text string into the corresponding locale encoding. |
621 | |
729 | |
622 | =item $string = $term->locale_decode $octets |
730 | =item $string = $term->locale_decode ($octets) |
623 | |
731 | |
624 | Convert the given locale-encoded octets into a perl string. |
732 | Convert the given locale-encoded octets into a perl string. |
625 | |
733 | |
626 | =item $term->scr_add_lines ($string) |
734 | =item $term->scr_add_lines ($string) |
627 | |
735 | |
… | |
… | |
632 | |
740 | |
633 | Normally its not a good idea to use this function, as programs might be |
741 | Normally its not a good idea to use this function, as programs might be |
634 | confused by changes in cursor position or scrolling. Its useful inside a |
742 | confused by changes in cursor position or scrolling. Its useful inside a |
635 | C<on_add_lines> hook, though. |
743 | C<on_add_lines> hook, though. |
636 | |
744 | |
|
|
745 | =item $term->cmd_parse ($octets) |
|
|
746 | |
|
|
747 | Similar to C<scr_add_lines>, but the argument must be in the |
|
|
748 | locale-specific encoding of the terminal and can contain command sequences |
|
|
749 | (escape codes) that will be interpreted. |
|
|
750 | |
637 | =item $term->tt_write ($octets) |
751 | =item $term->tt_write ($octets) |
638 | |
752 | |
639 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
753 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
640 | pass characters instead of octets, you should convert your strings first |
754 | pass characters instead of octets, you should convert your strings first |
641 | to the locale-specific encoding using C<< $term->locale_encode >>. |
755 | to the locale-specific encoding using C<< $term->locale_encode >>. |
642 | |
756 | |
|
|
757 | =item $windowid = $term->parent |
|
|
758 | |
|
|
759 | Return the window id of the toplevel window. |
|
|
760 | |
|
|
761 | =item $windowid = $term->vt |
|
|
762 | |
|
|
763 | Return the window id of the terminal window. |
|
|
764 | |
643 | =item $window_width = $term->width |
765 | =item $window_width = $term->width |
644 | |
766 | |
645 | =item $window_height = $term->height |
767 | =item $window_height = $term->height |
646 | |
768 | |
647 | =item $font_width = $term->fwidth |
769 | =item $font_width = $term->fwidth |
… | |
… | |
663 | =item $nrow_plus_saveLines = $term->total_rows |
785 | =item $nrow_plus_saveLines = $term->total_rows |
664 | |
786 | |
665 | =item $lines_in_scrollback = $term->nsaved |
787 | =item $lines_in_scrollback = $term->nsaved |
666 | |
788 | |
667 | Return various integers describing terminal characteristics. |
789 | Return various integers describing terminal characteristics. |
|
|
790 | |
|
|
791 | =item $modifiermask = $term->ModLevel3Mask |
|
|
792 | |
|
|
793 | =item $modifiermask = $term->ModMetaMask |
|
|
794 | |
|
|
795 | =item $modifiermask = $term->ModNumLockMask |
|
|
796 | |
|
|
797 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
|
|
798 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
668 | |
799 | |
669 | =item $view_start = $term->view_start ([$newvalue]) |
800 | =item $view_start = $term->view_start ([$newvalue]) |
670 | |
801 | |
671 | Returns the negative row number of the topmost line. Minimum value is |
802 | Returns the negative row number of the topmost line. Minimum value is |
672 | C<0>, which displays the normal terminal contents. Larger values scroll |
803 | C<0>, which displays the normal terminal contents. Larger values scroll |
… | |
… | |
735 | about the logical line that row C<$row_number> is part of. It supports the |
866 | about the logical line that row C<$row_number> is part of. It supports the |
736 | following methods: |
867 | following methods: |
737 | |
868 | |
738 | =over 4 |
869 | =over 4 |
739 | |
870 | |
740 | =item $text = $line->t |
871 | =item $text = $line->t ([$new_text]) |
741 | |
872 | |
742 | Returns the full text of the line, similar to C<ROW_t> |
873 | Returns or replaces the full text of the line, similar to C<ROW_t> |
743 | |
874 | |
744 | =item $rend = $line->r |
875 | =item $rend = $line->r ([$new_rend]) |
745 | |
876 | |
746 | Returns the full rendition array of the line, similar to C<ROW_r> |
877 | Returns or replaces the full rendition array of the line, similar to C<ROW_r> |
747 | |
878 | |
748 | =item $length = $line->l |
879 | =item $length = $line->l |
749 | |
880 | |
750 | Returns the length of the line in cells, similar to C<ROW_l>. |
881 | Returns the length of the line in cells, similar to C<ROW_l>. |
751 | |
882 | |
… | |
… | |
780 | |
911 | |
781 | bless { |
912 | bless { |
782 | term => $self, |
913 | term => $self, |
783 | beg => $beg, |
914 | beg => $beg, |
784 | end => $end, |
915 | end => $end, |
|
|
916 | ncol => $self->ncol, |
785 | len => ($end - $beg) * $self->ncol + $self->ROW_l ($end), |
917 | len => ($end - $beg) * $self->ncol + $self->ROW_l ($end), |
786 | }, urxvt::line:: |
918 | }, urxvt::line:: |
787 | } |
919 | } |
788 | |
920 | |
789 | sub urxvt::line::t { |
921 | sub urxvt::line::t { |
790 | my ($self) = @_; |
922 | my ($self) = @_; |
791 | |
923 | |
|
|
924 | if (@_ > 1) |
|
|
925 | { |
|
|
926 | $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
|
|
927 | for $self->{beg} .. $self->{end}; |
|
|
928 | } |
|
|
929 | |
|
|
930 | defined wantarray && |
792 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
931 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
793 | 0, $self->{len} |
932 | 0, $self->{len} |
794 | } |
933 | } |
795 | |
934 | |
796 | sub urxvt::line::r { |
935 | sub urxvt::line::r { |
797 | my ($self) = @_; |
936 | my ($self) = @_; |
798 | |
937 | |
|
|
938 | if (@_ > 1) |
|
|
939 | { |
|
|
940 | $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
|
|
941 | for $self->{beg} .. $self->{end}; |
|
|
942 | } |
|
|
943 | |
|
|
944 | if (defined wantarray) { |
799 | my $rend = [ |
945 | my $rend = [ |
800 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
946 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
801 | ]; |
947 | ]; |
802 | $#$rend = $self->{len} - 1; |
948 | $#$rend = $self->{len} - 1; |
803 | $rend |
949 | return $rend; |
|
|
950 | } |
|
|
951 | |
|
|
952 | () |
804 | } |
953 | } |
805 | |
954 | |
806 | sub urxvt::line::beg { $_[0]{beg} } |
955 | sub urxvt::line::beg { $_[0]{beg} } |
807 | sub urxvt::line::end { $_[0]{end} } |
956 | sub urxvt::line::end { $_[0]{end} } |
808 | sub urxvt::line::l { $_[0]{len} } |
957 | sub urxvt::line::l { $_[0]{len} } |
809 | |
958 | |
810 | sub urxvt::line::offset_of { |
959 | sub urxvt::line::offset_of { |
811 | my ($self, $row, $col) = @_; |
960 | my ($self, $row, $col) = @_; |
812 | |
961 | |
813 | ($row - $self->{beg}) * $self->{term}->ncol + $col |
962 | ($row - $self->{beg}) * $self->{ncol} + $col |
814 | } |
963 | } |
815 | |
964 | |
816 | sub urxvt::line::coord_of { |
965 | sub urxvt::line::coord_of { |
817 | my ($self, $offset) = @_; |
966 | my ($self, $offset) = @_; |
818 | |
967 | |
819 | use integer; |
968 | use integer; |
820 | |
969 | |
821 | ( |
970 | ( |
822 | $offset / $self->{term}->ncol + $self->{beg}, |
971 | $offset / $self->{ncol} + $self->{beg}, |
823 | $offset % $self->{term}->ncol |
972 | $offset % $self->{ncol} |
824 | ) |
973 | ) |
825 | } |
974 | } |
826 | |
975 | |
827 | =item ($row, $col) = $line->coord_of ($offset) |
976 | =item ($row, $col) = $line->coord_of ($offset) |
828 | =item $text = $term->special_encode $string |
977 | =item $text = $term->special_encode $string |
… | |
… | |
835 | |
984 | |
836 | Converts rxvt-unicodes text reprsentation into a perl string. See |
985 | Converts rxvt-unicodes text reprsentation into a perl string. See |
837 | C<< $term->ROW_t >> for details. |
986 | C<< $term->ROW_t >> for details. |
838 | |
987 | |
839 | =back |
988 | =back |
|
|
989 | |
|
|
990 | =head2 The C<urxvt::popup> Class |
|
|
991 | |
|
|
992 | =over 4 |
|
|
993 | |
|
|
994 | =cut |
|
|
995 | |
|
|
996 | package urxvt::popup; |
|
|
997 | |
|
|
998 | sub add_item { |
|
|
999 | my ($self, $item) = @_; |
|
|
1000 | |
|
|
1001 | push @{ $self->{item} }, $item; |
|
|
1002 | } |
|
|
1003 | |
|
|
1004 | sub add_button { |
|
|
1005 | my ($self, $text, $cb) = @_; |
|
|
1006 | |
|
|
1007 | $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb, |
|
|
1008 | render => sub { $_[0]{text} }, |
|
|
1009 | }); |
|
|
1010 | } |
|
|
1011 | |
|
|
1012 | sub add_toggle { |
|
|
1013 | my ($self, $text, $cb, $value) = @_; |
|
|
1014 | |
|
|
1015 | $self->add_item ({ type => "button", text => " $text", value => $value, |
|
|
1016 | render => sub { ($_[0]{value} ? "✔" : " ") . substr $_[0]{text}, 1 }, |
|
|
1017 | activate => sub { $cb->($_[0]{value} = !$_[0]{value}); }, |
|
|
1018 | }); |
|
|
1019 | } |
|
|
1020 | |
|
|
1021 | sub show { |
|
|
1022 | my ($self) = @_; |
|
|
1023 | |
|
|
1024 | local $urxvt::popup::self = $self; |
|
|
1025 | |
|
|
1026 | urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
|
|
1027 | "--transient-for" => $self->{term}->parent, |
|
|
1028 | "-pe" => "urxvt-popup") |
|
|
1029 | or die "unable to create popup window\n"; |
|
|
1030 | } |
|
|
1031 | |
|
|
1032 | sub DESTROY { |
|
|
1033 | my ($self) = @_; |
|
|
1034 | |
|
|
1035 | $self->{term}->ungrab; |
|
|
1036 | } |
840 | |
1037 | |
841 | =head2 The C<urxvt::timer> Class |
1038 | =head2 The C<urxvt::timer> Class |
842 | |
1039 | |
843 | This class implements timer watchers/events. Time is represented as a |
1040 | This class implements timer watchers/events. Time is represented as a |
844 | fractional number of seconds since the epoch. Example: |
1041 | fractional number of seconds since the epoch. Example: |