| … | |
… | |
| 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 filtering (C<on_line_update>) to underline urls. |
|
|
68 | |
| 65 | =item example-refresh-hooks |
69 | =item example-refresh-hooks |
| 66 | |
70 | |
| 67 | 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 |
| 68 | window. Illustrates overwriting the refresh callbacks to create your own |
72 | window. Illustrates overwriting the refresh callbacks to create your own |
| 69 | overlays or changes. |
73 | overlays or changes. |
|
|
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. |
| 70 | |
81 | |
| 71 | =back |
82 | =back |
| 72 | |
83 | |
| 73 | =head2 General API Considerations |
84 | =head2 General API Considerations |
| 74 | |
85 | |
| … | |
… | |
| 81 | 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 |
| 82 | 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 |
| 83 | 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 |
| 84 | terminal is destroyed. |
95 | terminal is destroyed. |
| 85 | |
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 | |
| 86 | =head2 Hooks |
120 | =head2 Hooks |
| 87 | |
121 | |
| 88 | The following subroutines can be declared in loaded scripts, and will be |
122 | The following subroutines can be declared in loaded scripts, and will be |
| 89 | called whenever the relevant event happens. |
123 | called whenever the relevant event happens. |
| 90 | |
124 | |
| … | |
… | |
| 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 |
| … | |
… | |
| 174 | |
211 | |
| 175 | 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. |
| 176 | |
213 | |
| 177 | =item on_osc_seq $term, $string |
214 | =item on_osc_seq $term, $string |
| 178 | |
215 | |
| 179 | Called whenever the B<ESC ] 777 ; string ST> command sequence is |
216 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
| 180 | processed. Cursor position and other state information is up-to-date when |
217 | operating system command) is processed. Cursor position and other state |
| 181 | this happens. For interoperability, the string should start with the |
218 | information is up-to-date when this happens. For interoperability, the |
| 182 | extension name and a colon, to distinguish it from commands for other |
219 | string should start with the extension name and a colon, to distinguish |
| 183 | extensions, and this might be enforced in the future. |
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. |
| 184 | |
248 | |
| 185 | =item on_refresh_begin $term |
249 | =item on_refresh_begin $term |
| 186 | |
250 | |
| 187 | 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 |
| 188 | or similar effects by modify terminal contents in refresh_begin, and |
252 | or similar effects by modify terminal contents in refresh_begin, and |
| … | |
… | |
| 213 | =back |
277 | =back |
| 214 | |
278 | |
| 215 | =head2 Functions in the C<urxvt> Package |
279 | =head2 Functions in the C<urxvt> Package |
| 216 | |
280 | |
| 217 | =over 4 |
281 | =over 4 |
|
|
282 | |
|
|
283 | =item $term = new urxvt [arg...] |
|
|
284 | |
|
|
285 | Creates a new terminal, very similar as if you had started it with |
|
|
286 | C<system $binfile, arg...>. Croaks (and probably outputs an error message) |
|
|
287 | if the new instance couldn't be created. Returns C<undef> if the new |
|
|
288 | instance didn't initialise perl, and the terminal object otherwise. The |
|
|
289 | C<init> and C<start> hooks will be called during the call. |
| 218 | |
290 | |
| 219 | =item urxvt::fatal $errormessage |
291 | =item urxvt::fatal $errormessage |
| 220 | |
292 | |
| 221 | Fatally aborts execution with the given error message. Avoid at all |
293 | Fatally aborts execution with the given error message. Avoid at all |
| 222 | costs! The only time this is acceptable is when the terminal process |
294 | costs! The only time this is acceptable is when the terminal process |
| … | |
… | |
| 361 | |
433 | |
| 362 | $pkg |
434 | $pkg |
| 363 | } |
435 | } |
| 364 | } |
436 | } |
| 365 | |
437 | |
|
|
438 | our $retval; # return value for urxvt |
|
|
439 | |
| 366 | # called by the rxvt core |
440 | # called by the rxvt core |
| 367 | sub invoke { |
441 | sub invoke { |
| 368 | local $TERM = shift; |
442 | local $TERM = shift; |
| 369 | my $htype = shift; |
443 | my $htype = shift; |
| 370 | |
444 | |
| 371 | if ($htype == 0) { # INIT |
445 | if ($htype == 0) { # INIT |
| 372 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
446 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
| 373 | |
447 | |
| 374 | for my $ext (split /:/, $TERM->resource ("perl_ext")) { |
448 | for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
| 375 | my @files = grep -f $_, map "$_/$ext", @dirs; |
449 | my @files = grep -f $_, map "$_/$ext", @dirs; |
| 376 | |
450 | |
| 377 | if (@files) { |
451 | if (@files) { |
| 378 | register_package script_package $files[0]; |
452 | register_package script_package $files[0]; |
| 379 | } else { |
453 | } else { |
| 380 | warn "perl extension '$ext' not found in perl library search path\n"; |
454 | warn "perl extension '$ext' not found in perl library search path\n"; |
| 381 | } |
455 | } |
| 382 | } |
456 | } |
|
|
457 | } |
| 383 | |
458 | |
|
|
459 | $retval = undef; |
|
|
460 | |
|
|
461 | if (my $cb = $TERM->{_hook}[$htype]) { |
|
|
462 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
|
|
463 | if $verbosity >= 10; |
|
|
464 | |
|
|
465 | keys %$cb; |
|
|
466 | |
|
|
467 | while (my ($pkg, $cb) = each %$cb) { |
|
|
468 | $retval = $cb->( |
|
|
469 | $TERM->{_pkg}{$pkg} ||= do { |
|
|
470 | my $proxy = bless { }, urxvt::term::proxy::; |
|
|
471 | Scalar::Util::weaken ($proxy->{term} = $TERM); |
|
|
472 | $proxy |
|
|
473 | }, |
|
|
474 | @_, |
|
|
475 | ) and last; |
|
|
476 | } |
|
|
477 | } |
|
|
478 | |
| 384 | } elsif ($htype == 1) { # DESTROY |
479 | if ($htype == 1) { # DESTROY |
|
|
480 | # remove hooks if unused |
| 385 | if (my $hook = $TERM->{_hook}) { |
481 | if (my $hook = $TERM->{_hook}) { |
| 386 | for my $htype (0..$#$hook) { |
482 | for my $htype (0..$#$hook) { |
| 387 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
483 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
| 388 | or set_should_invoke $htype, 0; |
484 | or set_should_invoke $htype, 0; |
| 389 | } |
485 | } |
| 390 | } |
486 | } |
|
|
487 | |
|
|
488 | # clear package objects |
|
|
489 | %$_ = () for values %{ $TERM->{_pkg} }; |
|
|
490 | |
|
|
491 | # clear package |
|
|
492 | %$TERM = (); |
| 391 | } |
493 | } |
| 392 | |
494 | |
| 393 | my $cb = $TERM->{_hook}[$htype] |
495 | $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 | } |
496 | } |
| 415 | |
497 | |
| 416 | sub urxvt::term::proxy::AUTOLOAD { |
498 | sub urxvt::term::proxy::AUTOLOAD { |
| 417 | $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ |
499 | $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ |
| 418 | or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; |
500 | or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; |
| … | |
… | |
| 430 | |
512 | |
| 431 | =head2 The C<urxvt::term> Class |
513 | =head2 The C<urxvt::term> Class |
| 432 | |
514 | |
| 433 | =over 4 |
515 | =over 4 |
| 434 | |
516 | |
|
|
517 | =item $term->destroy |
|
|
518 | |
|
|
519 | Destroy the terminal object (close the window, free resources etc.). |
|
|
520 | |
| 435 | =item $value = $term->resource ($name[, $newval]) |
521 | =item $value = $term->resource ($name[, $newval]) |
| 436 | |
522 | |
| 437 | Returns the current resource value associated with a given name and |
523 | 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> |
524 | optionally sets a new value. Setting values is most useful in the C<init> |
| 439 | hook. Unset resources are returned and accepted as C<undef>. |
525 | hook. Unset resources are returned and accepted as C<undef>. |
| … | |
… | |
| 456 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
542 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
| 457 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
543 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
| 458 | display_name embed ext_bwidth fade font geometry hold iconName |
544 | display_name embed ext_bwidth fade font geometry hold iconName |
| 459 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
545 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
| 460 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
546 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
| 461 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext |
547 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
| 462 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
548 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
| 463 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
549 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
| 464 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
550 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
| 465 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
551 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
| 466 | shade term_name title transparent transparent_all tripleclickwords |
552 | shade term_name title transparent transparent_all tripleclickwords |
| … | |
… | |
| 472 | my ($self, $name) = (shift, shift); |
558 | my ($self, $name) = (shift, shift); |
| 473 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
559 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
| 474 | goto &urxvt::term::_resource; |
560 | goto &urxvt::term::_resource; |
| 475 | } |
561 | } |
| 476 | |
562 | |
|
|
563 | =item $rend = $term->rstyle ([$new_rstyle]) |
|
|
564 | |
|
|
565 | Return and optionally change the current rendition. Text that is output by |
|
|
566 | the terminal application will use this style. |
|
|
567 | |
|
|
568 | =item ($row, $col) = $term->screen_cur ([$row, $col]) |
|
|
569 | |
|
|
570 | Return the current coordinates of the text cursor position and optionally |
|
|
571 | set it (which is usually bad as applications don't expect that). |
|
|
572 | |
| 477 | =item ($row, $col) = $term->selection_mark ([$row, $col]) |
573 | =item ($row, $col) = $term->selection_mark ([$row, $col]) |
| 478 | |
574 | |
| 479 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
575 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
| 480 | |
576 | |
| 481 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
577 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
| … | |
… | |
| 495 | #=item $term->overlay ($x, $y, $text) |
591 | #=item $term->overlay ($x, $y, $text) |
| 496 | # |
592 | # |
| 497 | #Create a simple multi-line overlay box. See the next method for details. |
593 | #Create a simple multi-line overlay box. See the next method for details. |
| 498 | # |
594 | # |
| 499 | #=cut |
595 | #=cut |
| 500 | |
596 | # |
| 501 | sub urxvt::term::scr_overlay { |
597 | #sub urxvt::term::scr_overlay { |
| 502 | die; |
|
|
| 503 | my ($self, $x, $y, $text) = @_; |
598 | # my ($self, $x, $y, $text) = @_; |
| 504 | |
599 | # |
| 505 | my @lines = split /\n/, $text; |
600 | # my @lines = split /\n/, $text; |
| 506 | |
601 | # |
| 507 | my $w = 0; |
602 | # my $w = 0; |
| 508 | for (map $self->strwidth ($_), @lines) { |
603 | # for (map $self->strwidth ($_), @lines) { |
| 509 | $w = $_ if $w < $_; |
604 | # $w = $_ if $w < $_; |
| 510 | } |
605 | # } |
| 511 | |
606 | # |
| 512 | $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
607 | # $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
| 513 | $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
608 | # $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
| 514 | } |
609 | #} |
| 515 | |
610 | |
| 516 | =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
611 | =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
| 517 | |
612 | |
| 518 | Create a new (empty) overlay at the given position with the given |
613 | Create a new (empty) overlay at the given position with the given |
| 519 | width/height. C<$rstyle> defines the initial rendition style |
614 | width/height. C<$rstyle> defines the initial rendition style |
| … | |
… | |
| 559 | |
654 | |
| 560 | =item $string = $term->locale_decode $octets |
655 | =item $string = $term->locale_decode $octets |
| 561 | |
656 | |
| 562 | Convert the given locale-encoded octets into a perl string. |
657 | Convert the given locale-encoded octets into a perl string. |
| 563 | |
658 | |
|
|
659 | =item $term->scr_add_lines ($string) |
|
|
660 | |
|
|
661 | Write the given text string to the screen, as if output by the application |
|
|
662 | running inside the terminal. It may not contain command sequences (escape |
|
|
663 | codes), but is free to use line feeds, carriage returns and tabs. The |
|
|
664 | string is a normal text string, not in locale-dependent encoding. |
|
|
665 | |
|
|
666 | Normally its not a good idea to use this function, as programs might be |
|
|
667 | confused by changes in cursor position or scrolling. Its useful inside a |
|
|
668 | C<on_add_lines> hook, though. |
|
|
669 | |
|
|
670 | =item $term->cmd_parse ($octets) |
|
|
671 | |
|
|
672 | Similar to C<scr_add_lines>, but the argument must be in the |
|
|
673 | locale-specific encoding of the terminal and can contain command sequences |
|
|
674 | (escape codes) that will be interpreted. |
|
|
675 | |
| 564 | =item $term->tt_write ($octets) |
676 | =item $term->tt_write ($octets) |
| 565 | |
677 | |
| 566 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
678 | 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 |
679 | pass characters instead of octets, you should convert your strings first |
| 568 | to the locale-specific encoding using C<< $term->locale_encode >>. |
680 | to the locale-specific encoding using C<< $term->locale_encode >>. |
| 569 | |
681 | |
|
|
682 | =item $window_width = $term->width |
|
|
683 | |
|
|
684 | =item $window_height = $term->height |
|
|
685 | |
|
|
686 | =item $font_width = $term->fwidth |
|
|
687 | |
|
|
688 | =item $font_height = $term->fheight |
|
|
689 | |
|
|
690 | =item $font_ascent = $term->fbase |
|
|
691 | |
| 570 | =item $nrow = $term->nrow |
692 | =item $terminal_rows = $term->nrow |
| 571 | |
693 | |
| 572 | =item $ncol = $term->ncol |
694 | =item $terminal_columns = $term->ncol |
| 573 | |
695 | |
| 574 | Return the number of rows/columns of the terminal window (i.e. as |
696 | =item $has_focus = $term->focus |
| 575 | specified by C<-geometry>, excluding any scrollback). |
|
|
| 576 | |
697 | |
| 577 | =item $nsaved = $term->nsaved |
698 | =item $is_mapped = $term->mapped |
| 578 | |
699 | |
| 579 | Returns the number of lines in the scrollback buffer. |
700 | =item $max_scrollback = $term->saveLines |
|
|
701 | |
|
|
702 | =item $nrow_plus_saveLines = $term->total_rows |
|
|
703 | |
|
|
704 | =item $lines_in_scrollback = $term->nsaved |
|
|
705 | |
|
|
706 | Return various integers describing terminal characteristics. |
| 580 | |
707 | |
| 581 | =item $view_start = $term->view_start ([$newvalue]) |
708 | =item $view_start = $term->view_start ([$newvalue]) |
| 582 | |
709 | |
| 583 | Returns the negative row number of the topmost line. Minimum value is |
710 | Returns the negative row number of the topmost line. Minimum value is |
| 584 | C<0>, which displays the normal terminal contents. Larger values scroll |
711 | 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 |
774 | about the logical line that row C<$row_number> is part of. It supports the |
| 648 | following methods: |
775 | following methods: |
| 649 | |
776 | |
| 650 | =over 4 |
777 | =over 4 |
| 651 | |
778 | |
| 652 | =item $text = $line->t |
779 | =item $text = $line->t ([$new_text]) |
| 653 | |
780 | |
| 654 | Returns the full text of the line, similar to C<ROW_t> |
781 | Returns or replaces the full text of the line, similar to C<ROW_t> |
| 655 | |
782 | |
| 656 | =item $rend = $line->r |
783 | =item $rend = $line->r ([$new_rend]) |
| 657 | |
784 | |
| 658 | Returns the full rendition array of the line, similar to C<ROW_r> |
785 | Returns or replaces the full rendition array of the line, similar to C<ROW_r> |
| 659 | |
786 | |
| 660 | =item $length = $line->l |
787 | =item $length = $line->l |
| 661 | |
788 | |
| 662 | Returns the length of the line in cells, similar to C<ROW_l>. |
789 | Returns the length of the line in cells, similar to C<ROW_l>. |
| 663 | |
790 | |
| … | |
… | |
| 692 | |
819 | |
| 693 | bless { |
820 | bless { |
| 694 | term => $self, |
821 | term => $self, |
| 695 | beg => $beg, |
822 | beg => $beg, |
| 696 | end => $end, |
823 | end => $end, |
|
|
824 | ncol => $self->ncol, |
| 697 | len => ($end - $beg) * $self->ncol + $self->ROW_l ($end), |
825 | len => ($end - $beg) * $self->ncol + $self->ROW_l ($end), |
| 698 | }, urxvt::line:: |
826 | }, urxvt::line:: |
| 699 | } |
827 | } |
| 700 | |
828 | |
| 701 | sub urxvt::line::t { |
829 | sub urxvt::line::t { |
| 702 | my ($self) = @_; |
830 | my ($self) = @_; |
| 703 | |
831 | |
|
|
832 | if (@_ > 1) |
|
|
833 | { |
|
|
834 | $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
|
|
835 | for $self->{beg} .. $self->{end}; |
|
|
836 | } |
|
|
837 | |
|
|
838 | defined wantarray && |
| 704 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
839 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
| 705 | 0, $self->{len} |
840 | 0, $self->{len} |
| 706 | } |
841 | } |
| 707 | |
842 | |
| 708 | sub urxvt::line::r { |
843 | sub urxvt::line::r { |
| 709 | my ($self) = @_; |
844 | my ($self) = @_; |
| 710 | |
845 | |
|
|
846 | if (@_ > 1) |
|
|
847 | { |
|
|
848 | $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
|
|
849 | for $self->{beg} .. $self->{end}; |
|
|
850 | } |
|
|
851 | |
|
|
852 | if (defined wantarray) { |
| 711 | my $rend = [ |
853 | my $rend = [ |
| 712 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
854 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
| 713 | ]; |
855 | ]; |
| 714 | $#$rend = $self->{len} - 1; |
856 | $#$rend = $self->{len} - 1; |
| 715 | $rend |
857 | return $rend; |
|
|
858 | } |
|
|
859 | |
|
|
860 | () |
| 716 | } |
861 | } |
| 717 | |
862 | |
| 718 | sub urxvt::line::beg { $_[0]{beg} } |
863 | sub urxvt::line::beg { $_[0]{beg} } |
| 719 | sub urxvt::line::end { $_[0]{end} } |
864 | sub urxvt::line::end { $_[0]{end} } |
| 720 | sub urxvt::line::l { $_[0]{len} } |
865 | sub urxvt::line::l { $_[0]{len} } |
| 721 | |
866 | |
| 722 | sub urxvt::line::offset_of { |
867 | sub urxvt::line::offset_of { |
| 723 | my ($self, $row, $col) = @_; |
868 | my ($self, $row, $col) = @_; |
| 724 | |
869 | |
| 725 | ($row - $self->{beg}) * $self->{term}->ncol + $col |
870 | ($row - $self->{beg}) * $self->{ncol} + $col |
| 726 | } |
871 | } |
| 727 | |
872 | |
| 728 | sub urxvt::line::coord_of { |
873 | sub urxvt::line::coord_of { |
| 729 | my ($self, $offset) = @_; |
874 | my ($self, $offset) = @_; |
| 730 | |
875 | |
| 731 | use integer; |
876 | use integer; |
| 732 | |
877 | |
| 733 | ( |
878 | ( |
| 734 | $offset / $self->{term}->ncol + $self->{beg}, |
879 | $offset / $self->{ncol} + $self->{beg}, |
| 735 | $offset % $self->{term}->ncol |
880 | $offset % $self->{ncol} |
| 736 | ) |
881 | ) |
| 737 | } |
882 | } |
| 738 | |
883 | |
| 739 | =item ($row, $col) = $line->coord_of ($offset) |
884 | =item ($row, $col) = $line->coord_of ($offset) |
| 740 | =item $text = $term->special_encode $string |
885 | =item $text = $term->special_encode $string |
