| … | |
… | |
| 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 | |
| … | |
… | |
| 80 | |
91 | |
| 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. |
|
|
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 |
| 85 | |
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. |
| … | |
… | |
| 184 | future. |
218 | future. |
| 185 | |
219 | |
| 186 | Be careful not ever to trust (in a security sense) the data you receive, |
220 | Be careful not ever to trust (in a security sense) the data you receive, |
| 187 | as its source can not easily be controleld (e-mail content, messages from |
221 | as its source can not easily be controleld (e-mail content, messages from |
| 188 | other users on the same system etc.). |
222 | other users on the same system etc.). |
|
|
223 | |
|
|
224 | =item on_add_lines $term, $string |
|
|
225 | |
|
|
226 | Called whenever text is about to be output, with the text as argument. You |
|
|
227 | can filter/change and output the text yourself by returning a true value |
|
|
228 | and calling C<< $term->scr_add_lines >> yourself. Please note that this |
|
|
229 | might be very slow, however, as your hook is called for B<all> text being |
|
|
230 | output. |
|
|
231 | |
|
|
232 | =item on_line_update $term, $row |
|
|
233 | |
|
|
234 | Called whenever a line was updated or changed. Can be used to filter |
|
|
235 | screen output (e.g. underline urls or other useless stuff). Only lines |
|
|
236 | that are being shown will be filtered, and, due to performance reasons, |
|
|
237 | not always immediately. |
|
|
238 | |
|
|
239 | The row number is always the topmost row of the line if the line spans |
|
|
240 | multiple rows. |
|
|
241 | |
|
|
242 | Please note that, if you change the line, then the hook might get called |
|
|
243 | later with the already-modified line (e.g. if unrelated parts change), so |
|
|
244 | you cannot just toggle rendition bits, but only set them. |
| 189 | |
245 | |
| 190 | =item on_refresh_begin $term |
246 | =item on_refresh_begin $term |
| 191 | |
247 | |
| 192 | Called just before the screen gets redrawn. Can be used for overlay |
248 | Called just before the screen gets redrawn. Can be used for overlay |
| 193 | or similar effects by modify terminal contents in refresh_begin, and |
249 | or similar effects by modify terminal contents in refresh_begin, and |
| … | |
… | |
| 487 | my ($self, $name) = (shift, shift); |
543 | my ($self, $name) = (shift, shift); |
| 488 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
544 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
| 489 | goto &urxvt::term::_resource; |
545 | goto &urxvt::term::_resource; |
| 490 | } |
546 | } |
| 491 | |
547 | |
|
|
548 | =item $rend = $term->rstyle ([$new_rstyle]) |
|
|
549 | |
|
|
550 | Return and optionally change the current rendition. Text that is output by |
|
|
551 | the terminal application will use this style. |
|
|
552 | |
|
|
553 | =item ($row, $col) = $term->screen_cur ([$row, $col]) |
|
|
554 | |
|
|
555 | Return the current coordinates of the text cursor position and optionally |
|
|
556 | set it (which is usually bad as applications don't expect that). |
|
|
557 | |
| 492 | =item ($row, $col) = $term->selection_mark ([$row, $col]) |
558 | =item ($row, $col) = $term->selection_mark ([$row, $col]) |
| 493 | |
559 | |
| 494 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
560 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
| 495 | |
561 | |
| 496 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
562 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
| … | |
… | |
| 510 | #=item $term->overlay ($x, $y, $text) |
576 | #=item $term->overlay ($x, $y, $text) |
| 511 | # |
577 | # |
| 512 | #Create a simple multi-line overlay box. See the next method for details. |
578 | #Create a simple multi-line overlay box. See the next method for details. |
| 513 | # |
579 | # |
| 514 | #=cut |
580 | #=cut |
| 515 | |
581 | # |
| 516 | sub urxvt::term::scr_overlay { |
582 | #sub urxvt::term::scr_overlay { |
| 517 | die; |
|
|
| 518 | my ($self, $x, $y, $text) = @_; |
583 | # my ($self, $x, $y, $text) = @_; |
| 519 | |
584 | # |
| 520 | my @lines = split /\n/, $text; |
585 | # my @lines = split /\n/, $text; |
| 521 | |
586 | # |
| 522 | my $w = 0; |
587 | # my $w = 0; |
| 523 | for (map $self->strwidth ($_), @lines) { |
588 | # for (map $self->strwidth ($_), @lines) { |
| 524 | $w = $_ if $w < $_; |
589 | # $w = $_ if $w < $_; |
| 525 | } |
590 | # } |
| 526 | |
591 | # |
| 527 | $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
592 | # $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
| 528 | $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
593 | # $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
| 529 | } |
594 | #} |
| 530 | |
595 | |
| 531 | =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
596 | =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
| 532 | |
597 | |
| 533 | Create a new (empty) overlay at the given position with the given |
598 | Create a new (empty) overlay at the given position with the given |
| 534 | width/height. C<$rstyle> defines the initial rendition style |
599 | width/height. C<$rstyle> defines the initial rendition style |
| … | |
… | |
| 574 | |
639 | |
| 575 | =item $string = $term->locale_decode $octets |
640 | =item $string = $term->locale_decode $octets |
| 576 | |
641 | |
| 577 | Convert the given locale-encoded octets into a perl string. |
642 | Convert the given locale-encoded octets into a perl string. |
| 578 | |
643 | |
|
|
644 | =item $term->scr_add_lines ($string) |
|
|
645 | |
|
|
646 | Write the given text string to the screen, as if output by the application |
|
|
647 | running inside the terminal. It may not contain command sequences (escape |
|
|
648 | codes), but is free to use line feeds, carriage returns and tabs. The |
|
|
649 | string is a normal text string, not in locale-dependent encoding. |
|
|
650 | |
|
|
651 | Normally its not a good idea to use this function, as programs might be |
|
|
652 | confused by changes in cursor position or scrolling. Its useful inside a |
|
|
653 | C<on_add_lines> hook, though. |
|
|
654 | |
| 579 | =item $term->tt_write ($octets) |
655 | =item $term->tt_write ($octets) |
| 580 | |
656 | |
| 581 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
657 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
| 582 | pass characters instead of octets, you should convert your strings first |
658 | pass characters instead of octets, you should convert your strings first |
| 583 | to the locale-specific encoding using C<< $term->locale_encode >>. |
659 | to the locale-specific encoding using C<< $term->locale_encode >>. |
| 584 | |
660 | |
|
|
661 | =item $window_width = $term->width |
|
|
662 | |
|
|
663 | =item $window_height = $term->height |
|
|
664 | |
|
|
665 | =item $font_width = $term->fwidth |
|
|
666 | |
|
|
667 | =item $font_height = $term->fheight |
|
|
668 | |
|
|
669 | =item $font_ascent = $term->fbase |
|
|
670 | |
| 585 | =item $nrow = $term->nrow |
671 | =item $terminal_rows = $term->nrow |
| 586 | |
672 | |
| 587 | =item $ncol = $term->ncol |
673 | =item $terminal_columns = $term->ncol |
| 588 | |
674 | |
| 589 | Return the number of rows/columns of the terminal window (i.e. as |
675 | =item $has_focus = $term->focus |
| 590 | specified by C<-geometry>, excluding any scrollback). |
|
|
| 591 | |
676 | |
| 592 | =item $nsaved = $term->nsaved |
677 | =item $is_mapped = $term->mapped |
| 593 | |
678 | |
| 594 | Returns the number of lines in the scrollback buffer. |
679 | =item $max_scrollback = $term->saveLines |
|
|
680 | |
|
|
681 | =item $nrow_plus_saveLines = $term->total_rows |
|
|
682 | |
|
|
683 | =item $lines_in_scrollback = $term->nsaved |
|
|
684 | |
|
|
685 | Return various integers describing terminal characteristics. |
| 595 | |
686 | |
| 596 | =item $view_start = $term->view_start ([$newvalue]) |
687 | =item $view_start = $term->view_start ([$newvalue]) |
| 597 | |
688 | |
| 598 | Returns the negative row number of the topmost line. Minimum value is |
689 | Returns the negative row number of the topmost line. Minimum value is |
| 599 | C<0>, which displays the normal terminal contents. Larger values scroll |
690 | C<0>, which displays the normal terminal contents. Larger values scroll |
| … | |
… | |
| 662 | about the logical line that row C<$row_number> is part of. It supports the |
753 | about the logical line that row C<$row_number> is part of. It supports the |
| 663 | following methods: |
754 | following methods: |
| 664 | |
755 | |
| 665 | =over 4 |
756 | =over 4 |
| 666 | |
757 | |
| 667 | =item $text = $line->t |
758 | =item $text = $line->t ([$new_text]) |
| 668 | |
759 | |
| 669 | Returns the full text of the line, similar to C<ROW_t> |
760 | Returns or replaces the full text of the line, similar to C<ROW_t> |
| 670 | |
761 | |
| 671 | =item $rend = $line->r |
762 | =item $rend = $line->r ([$new_rend]) |
| 672 | |
763 | |
| 673 | Returns the full rendition array of the line, similar to C<ROW_r> |
764 | Returns or replaces the full rendition array of the line, similar to C<ROW_r> |
| 674 | |
765 | |
| 675 | =item $length = $line->l |
766 | =item $length = $line->l |
| 676 | |
767 | |
| 677 | Returns the length of the line in cells, similar to C<ROW_l>. |
768 | Returns the length of the line in cells, similar to C<ROW_l>. |
| 678 | |
769 | |
| … | |
… | |
| 707 | |
798 | |
| 708 | bless { |
799 | bless { |
| 709 | term => $self, |
800 | term => $self, |
| 710 | beg => $beg, |
801 | beg => $beg, |
| 711 | end => $end, |
802 | end => $end, |
|
|
803 | ncol => $self->ncol, |
| 712 | len => ($end - $beg) * $self->ncol + $self->ROW_l ($end), |
804 | len => ($end - $beg) * $self->ncol + $self->ROW_l ($end), |
| 713 | }, urxvt::line:: |
805 | }, urxvt::line:: |
| 714 | } |
806 | } |
| 715 | |
807 | |
| 716 | sub urxvt::line::t { |
808 | sub urxvt::line::t { |
| 717 | my ($self) = @_; |
809 | my ($self) = @_; |
| 718 | |
810 | |
|
|
811 | if (@_ > 1) |
|
|
812 | { |
|
|
813 | $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
|
|
814 | for $self->{beg} .. $self->{end}; |
|
|
815 | } |
|
|
816 | |
|
|
817 | defined wantarray && |
| 719 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
818 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
| 720 | 0, $self->{len} |
819 | 0, $self->{len} |
| 721 | } |
820 | } |
| 722 | |
821 | |
| 723 | sub urxvt::line::r { |
822 | sub urxvt::line::r { |
| 724 | my ($self) = @_; |
823 | my ($self) = @_; |
| 725 | |
824 | |
|
|
825 | if (@_ > 1) |
|
|
826 | { |
|
|
827 | $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
|
|
828 | for $self->{beg} .. $self->{end}; |
|
|
829 | } |
|
|
830 | |
|
|
831 | if (defined wantarray) { |
| 726 | my $rend = [ |
832 | my $rend = [ |
| 727 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
833 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
| 728 | ]; |
834 | ]; |
| 729 | $#$rend = $self->{len} - 1; |
835 | $#$rend = $self->{len} - 1; |
| 730 | $rend |
836 | return $rend; |
|
|
837 | } |
|
|
838 | |
|
|
839 | () |
| 731 | } |
840 | } |
| 732 | |
841 | |
| 733 | sub urxvt::line::beg { $_[0]{beg} } |
842 | sub urxvt::line::beg { $_[0]{beg} } |
| 734 | sub urxvt::line::end { $_[0]{end} } |
843 | sub urxvt::line::end { $_[0]{end} } |
| 735 | sub urxvt::line::l { $_[0]{len} } |
844 | sub urxvt::line::l { $_[0]{len} } |
| 736 | |
845 | |
| 737 | sub urxvt::line::offset_of { |
846 | sub urxvt::line::offset_of { |
| 738 | my ($self, $row, $col) = @_; |
847 | my ($self, $row, $col) = @_; |
| 739 | |
848 | |
| 740 | ($row - $self->{beg}) * $self->{term}->ncol + $col |
849 | ($row - $self->{beg}) * $self->{ncol} + $col |
| 741 | } |
850 | } |
| 742 | |
851 | |
| 743 | sub urxvt::line::coord_of { |
852 | sub urxvt::line::coord_of { |
| 744 | my ($self, $offset) = @_; |
853 | my ($self, $offset) = @_; |
| 745 | |
854 | |
| 746 | use integer; |
855 | use integer; |
| 747 | |
856 | |
| 748 | ( |
857 | ( |
| 749 | $offset / $self->{term}->ncol + $self->{beg}, |
858 | $offset / $self->{ncol} + $self->{beg}, |
| 750 | $offset % $self->{term}->ncol |
859 | $offset % $self->{ncol} |
| 751 | ) |
860 | ) |
| 752 | } |
861 | } |
| 753 | |
862 | |
| 754 | =item ($row, $col) = $line->coord_of ($offset) |
863 | =item ($row, $col) = $line->coord_of ($offset) |
| 755 | =item $text = $term->special_encode $string |
864 | =item $text = $term->special_encode $string |
