… | |
… | |
39 | |
39 | |
40 | =over 4 |
40 | =over 4 |
41 | |
41 | |
42 | =item selection |
42 | =item selection |
43 | |
43 | |
44 | Intelligent selection. This etxension tries to be more intelligent when the user |
44 | Intelligent selection. This extension tries to be more intelligent when |
45 | extends selections (double-click). |
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>. |
46 | |
48 | |
47 | It also offers the following bindable event: |
49 | It also offers the following bindable event: |
48 | |
50 | |
49 | =over 4 |
51 | =over 4 |
50 | |
52 | |
… | |
… | |
57 | =back |
59 | =back |
58 | |
60 | |
59 | =item digital-clock |
61 | =item digital-clock |
60 | |
62 | |
61 | 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 filtering (C<on_line_update>) to underline urls. |
62 | |
68 | |
63 | =item example-refresh-hooks |
69 | =item example-refresh-hooks |
64 | |
70 | |
65 | Displays a very simple digital clock in the upper right corner of the |
71 | Displays a very simple digital clock in the upper right corner of the |
66 | window. Illustrates overwriting the refresh callbacks to create your own |
72 | window. Illustrates overwriting the refresh callbacks to create your own |
67 | overlays or changes. |
73 | overlays or changes. |
68 | |
74 | |
|
|
75 | =item example-filter-input |
|
|
76 | |
|
|
77 | A not very useful example of filtering all text output to the terminal, by |
|
|
78 | underlining all urls that matches a certain regex (i.e. some urls :). It |
|
|
79 | is not very useful because urls that are output in multiple steps (e.g. |
|
|
80 | when typing them) do not get marked. |
|
|
81 | |
69 | =back |
82 | =back |
70 | |
83 | |
71 | =head2 General API Considerations |
84 | =head2 General API Considerations |
72 | |
85 | |
73 | All objects (such as terminals, time watchers etc.) are typical |
86 | All objects (such as terminals, time watchers etc.) are typical |
74 | reference-to-hash objects. The hash can be used to store anything you |
87 | reference-to-hash objects. The hash can be used to store anything you |
75 | like. All members starting with an underscore (such as C<_ptr> or |
88 | like. All members starting with an underscore (such as C<_ptr> or |
76 | C<_hook>) are reserved for internal uses and must not be accessed or |
89 | C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or |
77 | modified). |
90 | modified). |
78 | |
91 | |
79 | When objects are destroyed on the C++ side, the perl object hashes are |
92 | When objects are destroyed on the C++ side, the perl object hashes are |
80 | emptied, so its best to store related objects such as time watchers and |
93 | emptied, so its best to store related objects such as time watchers and |
81 | the like inside the terminal object so they get destroyed as soon as the |
94 | the like inside the terminal object so they get destroyed as soon as the |
82 | terminal is destroyed. |
95 | terminal is destroyed. |
83 | |
96 | |
|
|
97 | Argument names also often indicate the type of a parameter. Here are some |
|
|
98 | hints on what they mean: |
|
|
99 | |
|
|
100 | =over 4 |
|
|
101 | |
|
|
102 | =item $text |
|
|
103 | |
|
|
104 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
|
|
105 | always represents one screen cell. See L<row_t> for a discussion of this format. |
|
|
106 | |
|
|
107 | =item $string |
|
|
108 | |
|
|
109 | A perl text string, with an emphasis on I<text>. It can store all unicode |
|
|
110 | characters and is to be distinguished with text encoded in a specific |
|
|
111 | encoding (often locale-specific) and binary data. |
|
|
112 | |
|
|
113 | =item $octets |
|
|
114 | |
|
|
115 | Either binary data or - more common - a text string encoded in a |
|
|
116 | locale-specific way. |
|
|
117 | |
|
|
118 | =back |
|
|
119 | |
84 | =head2 Hooks |
120 | =head2 Hooks |
85 | |
121 | |
86 | The following subroutines can be declared in loaded scripts, and will be called |
122 | The following subroutines can be declared in loaded scripts, and will be |
87 | whenever the relevant event happens. |
123 | called whenever the relevant event happens. |
|
|
124 | |
|
|
125 | The first argument passed to them is an object private to each terminal |
|
|
126 | and extension package. You can call all C<urxvt::term> methods on it, but |
|
|
127 | its not a real C<urxvt::term> object. Instead, the real C<urxvt::term> |
|
|
128 | object that is shared between all packages is stored in the C<term> |
|
|
129 | member. |
88 | |
130 | |
89 | 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 |
90 | 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, |
91 | 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. |
92 | |
134 | |
… | |
… | |
95 | =over 4 |
137 | =over 4 |
96 | |
138 | |
97 | =item on_init $term |
139 | =item on_init $term |
98 | |
140 | |
99 | Called after a new terminal object has been initialized, but before |
141 | Called after a new terminal object has been initialized, but before |
100 | 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. |
101 | |
146 | |
102 | =item on_reset $term |
147 | =item on_reset $term |
103 | |
148 | |
104 | 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 |
105 | 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 |
… | |
… | |
164 | |
209 | |
165 | =item on_tty_activity $term *NYI* |
210 | =item on_tty_activity $term *NYI* |
166 | |
211 | |
167 | Called whenever the program(s) running in the urxvt window send output. |
212 | Called whenever the program(s) running in the urxvt window send output. |
168 | |
213 | |
|
|
214 | =item on_osc_seq $term, $string |
|
|
215 | |
|
|
216 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
|
|
217 | operating system command) is processed. Cursor position and other state |
|
|
218 | information is up-to-date when this happens. For interoperability, the |
|
|
219 | string should start with the extension name and a colon, to distinguish |
|
|
220 | it from commands for other extensions, and this might be enforced in the |
|
|
221 | future. |
|
|
222 | |
|
|
223 | Be careful not ever to trust (in a security sense) the data you receive, |
|
|
224 | as its source can not easily be controleld (e-mail content, messages from |
|
|
225 | other users on the same system etc.). |
|
|
226 | |
|
|
227 | =item on_add_lines $term, $string |
|
|
228 | |
|
|
229 | Called whenever text is about to be output, with the text as argument. You |
|
|
230 | can filter/change and output the text yourself by returning a true value |
|
|
231 | and calling C<< $term->scr_add_lines >> yourself. Please note that this |
|
|
232 | might be very slow, however, as your hook is called for B<all> text being |
|
|
233 | output. |
|
|
234 | |
|
|
235 | =item on_line_update $term, $row |
|
|
236 | |
|
|
237 | Called whenever a line was updated or changed. Can be used to filter |
|
|
238 | screen output (e.g. underline urls or other useless stuff). Only lines |
|
|
239 | that are being shown will be filtered, and, due to performance reasons, |
|
|
240 | not always immediately. |
|
|
241 | |
|
|
242 | The row number is always the topmost row of the line if the line spans |
|
|
243 | multiple rows. |
|
|
244 | |
|
|
245 | Please note that, if you change the line, then the hook might get called |
|
|
246 | later with the already-modified line (e.g. if unrelated parts change), so |
|
|
247 | you cannot just toggle rendition bits, but only set them. |
|
|
248 | |
169 | =item on_refresh_begin $term |
249 | =item on_refresh_begin $term |
170 | |
250 | |
171 | Called just before the screen gets redrawn. Can be used for overlay |
251 | Called just before the screen gets redrawn. Can be used for overlay |
172 | or similar effects by modify terminal contents in refresh_begin, and |
252 | or similar effects by modify terminal contents in refresh_begin, and |
173 | restoring them in refresh_end. The built-in overlay and selection display |
253 | restoring them in refresh_end. The built-in overlay and selection display |
… | |
… | |
181 | |
261 | |
182 | Called whenever the user presses a key combination that has a |
262 | Called whenever the user presses a key combination that has a |
183 | C<perl:string> action bound to it (see description of the B<keysym> |
263 | C<perl:string> action bound to it (see description of the B<keysym> |
184 | resource in the @@RXVT_NAME@@(1) manpage). |
264 | resource in the @@RXVT_NAME@@(1) manpage). |
185 | |
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 | Called whenever the corresponding X event is received for the terminal If |
|
|
277 | the hook returns true, then the even will be ignored by rxvt-unicode. |
|
|
278 | |
|
|
279 | The event is a hash with most values as named by Xlib (see the XEvent |
|
|
280 | manpage), with the additional members C<row> and C<col>, which are the row |
|
|
281 | and column under the mouse cursor. |
|
|
282 | |
|
|
283 | C<on_key_press> additionally receives the string rxvt-unicode would |
|
|
284 | output, if any, in locale-specific encoding. |
|
|
285 | |
|
|
286 | subwindow. |
|
|
287 | |
|
|
288 | =back |
|
|
289 | |
|
|
290 | =head2 Variables in the C<urxvt> Package |
|
|
291 | |
|
|
292 | =over 4 |
|
|
293 | |
|
|
294 | =item $urxvt::TERM |
|
|
295 | |
|
|
296 | The current terminal. Whenever a callback/Hook is bein executed, this |
|
|
297 | variable stores the current C<urxvt::term> object. |
|
|
298 | |
186 | =back |
299 | =back |
187 | |
300 | |
188 | =head2 Functions in the C<urxvt> Package |
301 | =head2 Functions in the C<urxvt> Package |
189 | |
302 | |
190 | =over 4 |
303 | =over 4 |
|
|
304 | |
|
|
305 | =item $term = new urxvt [arg...] |
|
|
306 | |
|
|
307 | Creates a new terminal, very similar as if you had started it with |
|
|
308 | C<system $binfile, arg...>. Croaks (and probably outputs an error message) |
|
|
309 | if the new instance couldn't be created. Returns C<undef> if the new |
|
|
310 | instance didn't initialise perl, and the terminal object otherwise. The |
|
|
311 | C<init> and C<start> hooks will be called during the call. |
191 | |
312 | |
192 | =item urxvt::fatal $errormessage |
313 | =item urxvt::fatal $errormessage |
193 | |
314 | |
194 | Fatally aborts execution with the given error message. Avoid at all |
315 | Fatally aborts execution with the given error message. Avoid at all |
195 | costs! The only time this is acceptable is when the terminal process |
316 | costs! The only time this is acceptable is when the terminal process |
… | |
… | |
265 | =cut |
386 | =cut |
266 | |
387 | |
267 | package urxvt; |
388 | package urxvt; |
268 | |
389 | |
269 | use strict; |
390 | use strict; |
|
|
391 | use Scalar::Util (); |
270 | |
392 | |
271 | our $term; |
393 | our $TERM; |
272 | our @HOOKNAME; |
394 | our @HOOKNAME; |
273 | our $LIBDIR; |
395 | our $LIBDIR; |
274 | |
396 | |
275 | BEGIN { |
397 | BEGIN { |
276 | urxvt->bootstrap; |
398 | urxvt->bootstrap; |
… | |
… | |
301 | my $name = $HOOKNAME[$htype]; |
423 | my $name = $HOOKNAME[$htype]; |
302 | |
424 | |
303 | my $ref = $pkg->can ("on_" . lc $name) |
425 | my $ref = $pkg->can ("on_" . lc $name) |
304 | or next; |
426 | or next; |
305 | |
427 | |
306 | $term->{_hook}[$htype]{$ref*1} = $ref; |
428 | $TERM->{_hook}[$htype]{$pkg} = $ref; |
307 | $hook_count[$htype]++ |
429 | $hook_count[$htype]++ |
308 | or set_should_invoke $htype, 1; |
430 | or set_should_invoke $htype, 1; |
309 | } |
431 | } |
310 | } |
432 | } |
311 | |
433 | |
… | |
… | |
333 | |
455 | |
334 | $pkg |
456 | $pkg |
335 | } |
457 | } |
336 | } |
458 | } |
337 | |
459 | |
|
|
460 | our $retval; # return value for urxvt |
|
|
461 | |
338 | # called by the rxvt core |
462 | # called by the rxvt core |
339 | sub invoke { |
463 | sub invoke { |
340 | local $term = shift; |
464 | local $TERM = shift; |
341 | my $htype = shift; |
465 | my $htype = shift; |
342 | |
466 | |
343 | if ($htype == 0) { # INIT |
467 | if ($htype == 0) { # INIT |
344 | my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl"); |
468 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
345 | |
469 | |
346 | for my $ext (split /:/, $term->resource ("perl_ext")) { |
470 | for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
347 | my @files = grep -f $_, map "$_/$ext", @dirs; |
471 | my @files = grep -f $_, map "$_/$ext", @dirs; |
348 | |
472 | |
349 | if (@files) { |
473 | if (@files) { |
350 | register_package script_package $files[0]; |
474 | register_package script_package $files[0]; |
351 | } else { |
475 | } else { |
352 | warn "perl extension '$ext' not found in perl library search path\n"; |
476 | warn "perl extension '$ext' not found in perl library search path\n"; |
353 | } |
477 | } |
354 | } |
478 | } |
|
|
479 | } |
355 | |
480 | |
|
|
481 | $retval = undef; |
|
|
482 | |
|
|
483 | if (my $cb = $TERM->{_hook}[$htype]) { |
|
|
484 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
|
|
485 | if $verbosity >= 10; |
|
|
486 | |
|
|
487 | keys %$cb; |
|
|
488 | |
|
|
489 | while (my ($pkg, $cb) = each %$cb) { |
|
|
490 | $retval = $cb->( |
|
|
491 | $TERM->{_pkg}{$pkg} ||= do { |
|
|
492 | my $proxy = bless { }, urxvt::term::proxy::; |
|
|
493 | Scalar::Util::weaken ($proxy->{term} = $TERM); |
|
|
494 | $proxy |
|
|
495 | }, |
|
|
496 | @_, |
|
|
497 | ) and last; |
|
|
498 | } |
|
|
499 | } |
|
|
500 | |
356 | } elsif ($htype == 1) { # DESTROY |
501 | if ($htype == 1) { # DESTROY |
|
|
502 | # remove hooks if unused |
357 | if (my $hook = $term->{_hook}) { |
503 | if (my $hook = $TERM->{_hook}) { |
358 | for my $htype (0..$#$hook) { |
504 | for my $htype (0..$#$hook) { |
359 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
505 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
360 | or set_should_invoke $htype, 0; |
506 | or set_should_invoke $htype, 0; |
361 | } |
507 | } |
362 | } |
508 | } |
|
|
509 | |
|
|
510 | # clear package objects |
|
|
511 | %$_ = () for values %{ $TERM->{_pkg} }; |
|
|
512 | |
|
|
513 | # clear package |
|
|
514 | %$TERM = (); |
363 | } |
515 | } |
364 | |
516 | |
365 | my $cb = $term->{_hook}[$htype] |
517 | $retval |
366 | or return; |
518 | } |
367 | |
519 | |
368 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")" |
520 | sub urxvt::term::proxy::AUTOLOAD { |
369 | if $verbosity >= 10; |
521 | $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ |
|
|
522 | or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; |
370 | |
523 | |
371 | while (my ($k, $v) = each %$cb) { |
524 | eval qq{ |
372 | return 1 if $v->($term, @_); |
525 | sub $urxvt::term::proxy::AUTOLOAD { |
373 | } |
526 | my \$proxy = shift; |
|
|
527 | \$proxy->{term}->$1 (\@_) |
|
|
528 | } |
|
|
529 | 1 |
|
|
530 | } or die "FATAL: unable to compile method forwarder: $@"; |
374 | |
531 | |
375 | 0 |
532 | goto &$urxvt::term::proxy::AUTOLOAD; |
376 | } |
533 | } |
377 | |
534 | |
378 | =head2 The C<urxvt::term> Class |
535 | =head2 The C<urxvt::term> Class |
379 | |
536 | |
380 | =over 4 |
537 | =over 4 |
|
|
538 | |
|
|
539 | =item $term->destroy |
|
|
540 | |
|
|
541 | Destroy the terminal object (close the window, free resources etc.). |
381 | |
542 | |
382 | =item $value = $term->resource ($name[, $newval]) |
543 | =item $value = $term->resource ($name[, $newval]) |
383 | |
544 | |
384 | Returns the current resource value associated with a given name and |
545 | Returns the current resource value associated with a given name and |
385 | optionally sets a new value. Setting values is most useful in the C<init> |
546 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
403 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
564 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
404 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
565 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
405 | display_name embed ext_bwidth fade font geometry hold iconName |
566 | display_name embed ext_bwidth fade font geometry hold iconName |
406 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
567 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
407 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
568 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
408 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext |
569 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
409 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
570 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
410 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
571 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
411 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
572 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
412 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
573 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
413 | shade term_name title transparent transparent_all tripleclickwords |
574 | shade term_name title transparent transparent_all tripleclickwords |
… | |
… | |
419 | my ($self, $name) = (shift, shift); |
580 | my ($self, $name) = (shift, shift); |
420 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
581 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
421 | goto &urxvt::term::_resource; |
582 | goto &urxvt::term::_resource; |
422 | } |
583 | } |
423 | |
584 | |
|
|
585 | =item $rend = $term->rstyle ([$new_rstyle]) |
|
|
586 | |
|
|
587 | Return and optionally change the current rendition. Text that is output by |
|
|
588 | the terminal application will use this style. |
|
|
589 | |
|
|
590 | =item ($row, $col) = $term->screen_cur ([$row, $col]) |
|
|
591 | |
|
|
592 | Return the current coordinates of the text cursor position and optionally |
|
|
593 | set it (which is usually bad as applications don't expect that). |
|
|
594 | |
424 | =item ($row, $col) = $term->selection_mark ([$row, $col]) |
595 | =item ($row, $col) = $term->selection_mark ([$row, $col]) |
425 | |
596 | |
426 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
597 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
427 | |
598 | |
428 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
599 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
… | |
… | |
442 | #=item $term->overlay ($x, $y, $text) |
613 | #=item $term->overlay ($x, $y, $text) |
443 | # |
614 | # |
444 | #Create a simple multi-line overlay box. See the next method for details. |
615 | #Create a simple multi-line overlay box. See the next method for details. |
445 | # |
616 | # |
446 | #=cut |
617 | #=cut |
447 | |
618 | # |
448 | sub urxvt::term::scr_overlay { |
619 | #sub urxvt::term::scr_overlay { |
449 | die; |
|
|
450 | my ($self, $x, $y, $text) = @_; |
620 | # my ($self, $x, $y, $text) = @_; |
451 | |
621 | # |
452 | my @lines = split /\n/, $text; |
622 | # my @lines = split /\n/, $text; |
453 | |
623 | # |
454 | my $w = 0; |
624 | # my $w = 0; |
455 | for (map $self->strwidth ($_), @lines) { |
625 | # for (map $self->strwidth ($_), @lines) { |
456 | $w = $_ if $w < $_; |
626 | # $w = $_ if $w < $_; |
457 | } |
627 | # } |
458 | |
628 | # |
459 | $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
629 | # $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
460 | $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
630 | # $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
461 | } |
631 | #} |
462 | |
632 | |
463 | =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
633 | =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
464 | |
634 | |
465 | Create a new (empty) overlay at the given position with the given |
635 | Create a new (empty) overlay at the given position with the given |
466 | width/height. C<$rstyle> defines the initial rendition style |
636 | width/height. C<$rstyle> defines the initial rendition style |
… | |
… | |
493 | |
663 | |
494 | If hidden, display the overlay again. |
664 | If hidden, display the overlay again. |
495 | |
665 | |
496 | =back |
666 | =back |
497 | |
667 | |
498 | =item $cellwidth = $term->strwidth $string |
668 | =item $cellwidth = $term->strwidth ($string) |
499 | |
669 | |
500 | Returns the number of screen-cells this string would need. Correctly |
670 | Returns the number of screen-cells this string would need. Correctly |
501 | accounts for wide and combining characters. |
671 | accounts for wide and combining characters. |
502 | |
672 | |
503 | =item $octets = $term->locale_encode $string |
673 | =item $octets = $term->locale_encode ($string) |
504 | |
674 | |
505 | Convert the given text string into the corresponding locale encoding. |
675 | Convert the given text string into the corresponding locale encoding. |
506 | |
676 | |
507 | =item $string = $term->locale_decode $octets |
677 | =item $string = $term->locale_decode ($octets) |
508 | |
678 | |
509 | Convert the given locale-encoded octets into a perl string. |
679 | Convert the given locale-encoded octets into a perl string. |
|
|
680 | |
|
|
681 | =item $term->scr_add_lines ($string) |
|
|
682 | |
|
|
683 | Write the given text string to the screen, as if output by the application |
|
|
684 | running inside the terminal. It may not contain command sequences (escape |
|
|
685 | codes), but is free to use line feeds, carriage returns and tabs. The |
|
|
686 | string is a normal text string, not in locale-dependent encoding. |
|
|
687 | |
|
|
688 | Normally its not a good idea to use this function, as programs might be |
|
|
689 | confused by changes in cursor position or scrolling. Its useful inside a |
|
|
690 | C<on_add_lines> hook, though. |
|
|
691 | |
|
|
692 | =item $term->cmd_parse ($octets) |
|
|
693 | |
|
|
694 | Similar to C<scr_add_lines>, but the argument must be in the |
|
|
695 | locale-specific encoding of the terminal and can contain command sequences |
|
|
696 | (escape codes) that will be interpreted. |
510 | |
697 | |
511 | =item $term->tt_write ($octets) |
698 | =item $term->tt_write ($octets) |
512 | |
699 | |
513 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
700 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
514 | pass characters instead of octets, you should convert your strings first |
701 | pass characters instead of octets, you should convert your strings first |
515 | to the locale-specific encoding using C<< $term->locale_encode >>. |
702 | to the locale-specific encoding using C<< $term->locale_encode >>. |
516 | |
703 | |
|
|
704 | =item $windowid = $term->parent |
|
|
705 | |
|
|
706 | Return the window id of the toplevel window. |
|
|
707 | |
|
|
708 | =item $windowid = $term->vt |
|
|
709 | |
|
|
710 | Return the window id of the terminal window. |
|
|
711 | |
|
|
712 | =item $window_width = $term->width |
|
|
713 | |
|
|
714 | =item $window_height = $term->height |
|
|
715 | |
|
|
716 | =item $font_width = $term->fwidth |
|
|
717 | |
|
|
718 | =item $font_height = $term->fheight |
|
|
719 | |
|
|
720 | =item $font_ascent = $term->fbase |
|
|
721 | |
517 | =item $nrow = $term->nrow |
722 | =item $terminal_rows = $term->nrow |
518 | |
723 | |
519 | =item $ncol = $term->ncol |
724 | =item $terminal_columns = $term->ncol |
520 | |
725 | |
521 | Return the number of rows/columns of the terminal window (i.e. as |
726 | =item $has_focus = $term->focus |
522 | specified by C<-geometry>, excluding any scrollback). |
|
|
523 | |
727 | |
524 | =item $nsaved = $term->nsaved |
728 | =item $is_mapped = $term->mapped |
525 | |
729 | |
526 | Returns the number of lines in the scrollback buffer. |
730 | =item $max_scrollback = $term->saveLines |
|
|
731 | |
|
|
732 | =item $nrow_plus_saveLines = $term->total_rows |
|
|
733 | |
|
|
734 | =item $lines_in_scrollback = $term->nsaved |
|
|
735 | |
|
|
736 | Return various integers describing terminal characteristics. |
527 | |
737 | |
528 | =item $view_start = $term->view_start ([$newvalue]) |
738 | =item $view_start = $term->view_start ([$newvalue]) |
529 | |
739 | |
530 | Returns the negative row number of the topmost line. Minimum value is |
740 | Returns the negative row number of the topmost line. Minimum value is |
531 | C<0>, which displays the normal terminal contents. Larger values scroll |
741 | C<0>, which displays the normal terminal contents. Larger values scroll |
… | |
… | |
542 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
752 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
543 | |
753 | |
544 | Returns the text of the entire row with number C<$row_number>. Row C<0> |
754 | Returns the text of the entire row with number C<$row_number>. Row C<0> |
545 | is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost |
755 | is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost |
546 | terminal line. The scrollback buffer starts at line C<-1> and extends to |
756 | terminal line. The scrollback buffer starts at line C<-1> and extends to |
547 | line C<< -$term->nsaved >>. |
757 | line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line |
|
|
758 | is requested. |
548 | |
759 | |
549 | If C<$new_text> is specified, it will replace characters in the current |
760 | If C<$new_text> is specified, it will replace characters in the current |
550 | line, starting at column C<$start_col> (default C<0>), which is useful |
761 | line, starting at column C<$start_col> (default C<0>), which is useful |
551 | to replace only parts of a line. The font index in the rendition will |
762 | to replace only parts of a line. The font index in the rendition will |
552 | automatically be updated. |
763 | automatically be updated. |
… | |
… | |
574 | |
785 | |
575 | See the section on RENDITION, above. |
786 | See the section on RENDITION, above. |
576 | |
787 | |
577 | =item $length = $term->ROW_l ($row_number[, $new_length]) |
788 | =item $length = $term->ROW_l ($row_number[, $new_length]) |
578 | |
789 | |
579 | Returns the number of screen cells that are in use ("the line length"). If |
790 | Returns the number of screen cells that are in use ("the line |
580 | it is C<-1>, then the line is part of a multiple-row logical "line", which |
791 | length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the |
581 | means all characters are in use and it is continued on the next row. |
792 | line is joined with the following one. |
582 | |
793 | |
|
|
794 | =item $bool = $term->is_longer ($row_number) |
|
|
795 | |
|
|
796 | Returns true if the row is part of a multiple-row logical "line" (i.e. |
|
|
797 | joined with the following row), which means all characters are in use |
|
|
798 | and it is continued on the next row (and possibly a continuation of the |
|
|
799 | previous row(s)). |
|
|
800 | |
|
|
801 | =item $line = $term->line ($row_number) |
|
|
802 | |
|
|
803 | Create and return a new C<urxvt::line> object that stores information |
|
|
804 | about the logical line that row C<$row_number> is part of. It supports the |
|
|
805 | following methods: |
|
|
806 | |
|
|
807 | =over 4 |
|
|
808 | |
|
|
809 | =item $text = $line->t ([$new_text]) |
|
|
810 | |
|
|
811 | Returns or replaces the full text of the line, similar to C<ROW_t> |
|
|
812 | |
|
|
813 | =item $rend = $line->r ([$new_rend]) |
|
|
814 | |
|
|
815 | Returns or replaces the full rendition array of the line, similar to C<ROW_r> |
|
|
816 | |
|
|
817 | =item $length = $line->l |
|
|
818 | |
|
|
819 | Returns the length of the line in cells, similar to C<ROW_l>. |
|
|
820 | |
|
|
821 | =item $rownum = $line->beg |
|
|
822 | |
|
|
823 | =item $rownum = $line->end |
|
|
824 | |
|
|
825 | Return the row number of the first/last row of the line, respectively. |
|
|
826 | |
|
|
827 | =item $offset = $line->offset_of ($row, $col) |
|
|
828 | |
|
|
829 | Returns the character offset of the given row|col pair within the logical |
|
|
830 | line. |
|
|
831 | |
|
|
832 | =item ($row, $col) = $line->coord_of ($offset) |
|
|
833 | |
|
|
834 | Translates a string offset into terminal coordinates again. |
|
|
835 | |
|
|
836 | =back |
|
|
837 | |
|
|
838 | =cut |
|
|
839 | |
|
|
840 | sub urxvt::term::line { |
|
|
841 | my ($self, $row) = @_; |
|
|
842 | |
|
|
843 | my $maxrow = $self->nrow - 1; |
|
|
844 | |
|
|
845 | my ($beg, $end) = ($row, $row); |
|
|
846 | |
|
|
847 | --$beg while $self->ROW_is_longer ($beg - 1); |
|
|
848 | ++$end while $self->ROW_is_longer ($end) && $end < $maxrow; |
|
|
849 | |
|
|
850 | bless { |
|
|
851 | term => $self, |
|
|
852 | beg => $beg, |
|
|
853 | end => $end, |
|
|
854 | ncol => $self->ncol, |
|
|
855 | len => ($end - $beg) * $self->ncol + $self->ROW_l ($end), |
|
|
856 | }, urxvt::line:: |
|
|
857 | } |
|
|
858 | |
|
|
859 | sub urxvt::line::t { |
|
|
860 | my ($self) = @_; |
|
|
861 | |
|
|
862 | if (@_ > 1) |
|
|
863 | { |
|
|
864 | $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
|
|
865 | for $self->{beg} .. $self->{end}; |
|
|
866 | } |
|
|
867 | |
|
|
868 | defined wantarray && |
|
|
869 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
|
|
870 | 0, $self->{len} |
|
|
871 | } |
|
|
872 | |
|
|
873 | sub urxvt::line::r { |
|
|
874 | my ($self) = @_; |
|
|
875 | |
|
|
876 | if (@_ > 1) |
|
|
877 | { |
|
|
878 | $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
|
|
879 | for $self->{beg} .. $self->{end}; |
|
|
880 | } |
|
|
881 | |
|
|
882 | if (defined wantarray) { |
|
|
883 | my $rend = [ |
|
|
884 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
|
|
885 | ]; |
|
|
886 | $#$rend = $self->{len} - 1; |
|
|
887 | return $rend; |
|
|
888 | } |
|
|
889 | |
|
|
890 | () |
|
|
891 | } |
|
|
892 | |
|
|
893 | sub urxvt::line::beg { $_[0]{beg} } |
|
|
894 | sub urxvt::line::end { $_[0]{end} } |
|
|
895 | sub urxvt::line::l { $_[0]{len} } |
|
|
896 | |
|
|
897 | sub urxvt::line::offset_of { |
|
|
898 | my ($self, $row, $col) = @_; |
|
|
899 | |
|
|
900 | ($row - $self->{beg}) * $self->{ncol} + $col |
|
|
901 | } |
|
|
902 | |
|
|
903 | sub urxvt::line::coord_of { |
|
|
904 | my ($self, $offset) = @_; |
|
|
905 | |
|
|
906 | use integer; |
|
|
907 | |
|
|
908 | ( |
|
|
909 | $offset / $self->{ncol} + $self->{beg}, |
|
|
910 | $offset % $self->{ncol} |
|
|
911 | ) |
|
|
912 | } |
|
|
913 | |
|
|
914 | =item ($row, $col) = $line->coord_of ($offset) |
583 | =item $text = $term->special_encode $string |
915 | =item $text = $term->special_encode $string |
584 | |
916 | |
585 | Converts a perl string into the special encoding used by rxvt-unicode, |
917 | Converts a perl string into the special encoding used by rxvt-unicode, |
586 | where one character corresponds to one screen cell. See |
918 | where one character corresponds to one screen cell. See |
587 | C<< $term->ROW_t >> for details. |
919 | C<< $term->ROW_t >> for details. |
… | |
… | |
701 | This variable controls the verbosity level of the perl extension. Higher |
1033 | This variable controls the verbosity level of the perl extension. Higher |
702 | numbers indicate more verbose output. |
1034 | numbers indicate more verbose output. |
703 | |
1035 | |
704 | =over 4 |
1036 | =over 4 |
705 | |
1037 | |
706 | =item 0 - only fatal messages |
1038 | =item =0 - only fatal messages |
707 | |
1039 | |
708 | =item 3 - script loading and management |
1040 | =item =3 - script loading and management |
709 | |
1041 | |
710 | =item 10 - all events received |
1042 | =item =10 - all events received |
711 | |
1043 | |
712 | =back |
1044 | =back |
713 | |
1045 | |
714 | =head1 AUTHOR |
1046 | =head1 AUTHOR |
715 | |
1047 | |