| … | |
… | |
| 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 |
| … | |
… | |
| 185 | |
222 | |
| 186 | Be careful not ever to trust (in a security sense) the data you receive, |
223 | 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 |
224 | as its source can not easily be controleld (e-mail content, messages from |
| 188 | other users on the same system etc.). |
225 | other users on the same system etc.). |
| 189 | |
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 | |
| 190 | =item on_refresh_begin $term |
249 | =item on_refresh_begin $term |
| 191 | |
250 | |
| 192 | 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 |
| 193 | or similar effects by modify terminal contents in refresh_begin, and |
252 | or similar effects by modify terminal contents in refresh_begin, and |
| 194 | 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 |
| … | |
… | |
| 218 | =back |
277 | =back |
| 219 | |
278 | |
| 220 | =head2 Functions in the C<urxvt> Package |
279 | =head2 Functions in the C<urxvt> Package |
| 221 | |
280 | |
| 222 | =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. |
| 223 | |
290 | |
| 224 | =item urxvt::fatal $errormessage |
291 | =item urxvt::fatal $errormessage |
| 225 | |
292 | |
| 226 | Fatally aborts execution with the given error message. Avoid at all |
293 | Fatally aborts execution with the given error message. Avoid at all |
| 227 | 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 |
| … | |
… | |
| 444 | } |
511 | } |
| 445 | |
512 | |
| 446 | =head2 The C<urxvt::term> Class |
513 | =head2 The C<urxvt::term> Class |
| 447 | |
514 | |
| 448 | =over 4 |
515 | =over 4 |
|
|
516 | |
|
|
517 | =item $term->destroy |
|
|
518 | |
|
|
519 | Destroy the terminal object (close the window, free resources etc.). |
| 449 | |
520 | |
| 450 | =item $value = $term->resource ($name[, $newval]) |
521 | =item $value = $term->resource ($name[, $newval]) |
| 451 | |
522 | |
| 452 | Returns the current resource value associated with a given name and |
523 | Returns the current resource value associated with a given name and |
| 453 | 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> |
| … | |
… | |
| 487 | my ($self, $name) = (shift, shift); |
558 | my ($self, $name) = (shift, shift); |
| 488 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
559 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
| 489 | goto &urxvt::term::_resource; |
560 | goto &urxvt::term::_resource; |
| 490 | } |
561 | } |
| 491 | |
562 | |
| 492 | =item $rend = $term->screen_rstyle ([$new_rstyle]) |
563 | =item $rend = $term->rstyle ([$new_rstyle]) |
| 493 | |
564 | |
| 494 | Return and optionally change the current rendition. Text thta is output by |
565 | Return and optionally change the current rendition. Text that is output by |
| 495 | the temrianl application will use this style. |
566 | the terminal application will use this style. |
| 496 | |
567 | |
| 497 | =item ($row, $col) = $term->screen_cur ([$row, $col]) |
568 | =item ($row, $col) = $term->screen_cur ([$row, $col]) |
| 498 | |
569 | |
| 499 | Return the current coordinates of the text cursor position and optionally |
570 | Return the current coordinates of the text cursor position and optionally |
| 500 | set it (which is usually bad as applications don't expect that). |
571 | set it (which is usually bad as applications don't expect that). |
| … | |
… | |
| 520 | #=item $term->overlay ($x, $y, $text) |
591 | #=item $term->overlay ($x, $y, $text) |
| 521 | # |
592 | # |
| 522 | #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. |
| 523 | # |
594 | # |
| 524 | #=cut |
595 | #=cut |
| 525 | |
596 | # |
| 526 | sub urxvt::term::scr_overlay { |
597 | #sub urxvt::term::scr_overlay { |
| 527 | die; |
|
|
| 528 | my ($self, $x, $y, $text) = @_; |
598 | # my ($self, $x, $y, $text) = @_; |
| 529 | |
599 | # |
| 530 | my @lines = split /\n/, $text; |
600 | # my @lines = split /\n/, $text; |
| 531 | |
601 | # |
| 532 | my $w = 0; |
602 | # my $w = 0; |
| 533 | for (map $self->strwidth ($_), @lines) { |
603 | # for (map $self->strwidth ($_), @lines) { |
| 534 | $w = $_ if $w < $_; |
604 | # $w = $_ if $w < $_; |
| 535 | } |
605 | # } |
| 536 | |
606 | # |
| 537 | $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
607 | # $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
| 538 | $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
608 | # $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
| 539 | } |
609 | #} |
| 540 | |
610 | |
| 541 | =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
611 | =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
| 542 | |
612 | |
| 543 | 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 |
| 544 | width/height. C<$rstyle> defines the initial rendition style |
614 | width/height. C<$rstyle> defines the initial rendition style |
| … | |
… | |
| 583 | Convert the given text string into the corresponding locale encoding. |
653 | Convert the given text string into the corresponding locale encoding. |
| 584 | |
654 | |
| 585 | =item $string = $term->locale_decode $octets |
655 | =item $string = $term->locale_decode $octets |
| 586 | |
656 | |
| 587 | Convert the given locale-encoded octets into a perl string. |
657 | Convert the given locale-encoded octets into a perl string. |
|
|
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. |
| 588 | |
675 | |
| 589 | =item $term->tt_write ($octets) |
676 | =item $term->tt_write ($octets) |
| 590 | |
677 | |
| 591 | 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 |
| 592 | pass characters instead of octets, you should convert your strings first |
679 | pass characters instead of octets, you should convert your strings first |
| … | |
… | |
| 687 | 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 |
| 688 | following methods: |
775 | following methods: |
| 689 | |
776 | |
| 690 | =over 4 |
777 | =over 4 |
| 691 | |
778 | |
| 692 | =item $text = $line->t |
779 | =item $text = $line->t ([$new_text]) |
| 693 | |
780 | |
| 694 | 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> |
| 695 | |
782 | |
| 696 | =item $rend = $line->r |
783 | =item $rend = $line->r ([$new_rend]) |
| 697 | |
784 | |
| 698 | 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> |
| 699 | |
786 | |
| 700 | =item $length = $line->l |
787 | =item $length = $line->l |
| 701 | |
788 | |
| 702 | 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>. |
| 703 | |
790 | |
| … | |
… | |
| 732 | |
819 | |
| 733 | bless { |
820 | bless { |
| 734 | term => $self, |
821 | term => $self, |
| 735 | beg => $beg, |
822 | beg => $beg, |
| 736 | end => $end, |
823 | end => $end, |
|
|
824 | ncol => $self->ncol, |
| 737 | len => ($end - $beg) * $self->ncol + $self->ROW_l ($end), |
825 | len => ($end - $beg) * $self->ncol + $self->ROW_l ($end), |
| 738 | }, urxvt::line:: |
826 | }, urxvt::line:: |
| 739 | } |
827 | } |
| 740 | |
828 | |
| 741 | sub urxvt::line::t { |
829 | sub urxvt::line::t { |
| 742 | my ($self) = @_; |
830 | my ($self) = @_; |
| 743 | |
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 && |
| 744 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
839 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
| 745 | 0, $self->{len} |
840 | 0, $self->{len} |
| 746 | } |
841 | } |
| 747 | |
842 | |
| 748 | sub urxvt::line::r { |
843 | sub urxvt::line::r { |
| 749 | my ($self) = @_; |
844 | my ($self) = @_; |
| 750 | |
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) { |
| 751 | my $rend = [ |
853 | my $rend = [ |
| 752 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
854 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
| 753 | ]; |
855 | ]; |
| 754 | $#$rend = $self->{len} - 1; |
856 | $#$rend = $self->{len} - 1; |
| 755 | $rend |
857 | return $rend; |
|
|
858 | } |
|
|
859 | |
|
|
860 | () |
| 756 | } |
861 | } |
| 757 | |
862 | |
| 758 | sub urxvt::line::beg { $_[0]{beg} } |
863 | sub urxvt::line::beg { $_[0]{beg} } |
| 759 | sub urxvt::line::end { $_[0]{end} } |
864 | sub urxvt::line::end { $_[0]{end} } |
| 760 | sub urxvt::line::l { $_[0]{len} } |
865 | sub urxvt::line::l { $_[0]{len} } |
| 761 | |
866 | |
| 762 | sub urxvt::line::offset_of { |
867 | sub urxvt::line::offset_of { |
| 763 | my ($self, $row, $col) = @_; |
868 | my ($self, $row, $col) = @_; |
| 764 | |
869 | |
| 765 | ($row - $self->{beg}) * $self->{term}->ncol + $col |
870 | ($row - $self->{beg}) * $self->{ncol} + $col |
| 766 | } |
871 | } |
| 767 | |
872 | |
| 768 | sub urxvt::line::coord_of { |
873 | sub urxvt::line::coord_of { |
| 769 | my ($self, $offset) = @_; |
874 | my ($self, $offset) = @_; |
| 770 | |
875 | |
| 771 | use integer; |
876 | use integer; |
| 772 | |
877 | |
| 773 | ( |
878 | ( |
| 774 | $offset / $self->{term}->ncol + $self->{beg}, |
879 | $offset / $self->{ncol} + $self->{beg}, |
| 775 | $offset % $self->{term}->ncol |
880 | $offset % $self->{ncol} |
| 776 | ) |
881 | ) |
| 777 | } |
882 | } |
| 778 | |
883 | |
| 779 | =item ($row, $col) = $line->coord_of ($offset) |
884 | =item ($row, $col) = $line->coord_of ($offset) |
| 780 | =item $text = $term->special_encode $string |
885 | =item $text = $term->special_encode $string |
