… | |
… | |
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 |
… | |
… | |
202 | |
261 | |
203 | Called whenever the user presses a key combination that has a |
262 | Called whenever the user presses a key combination that has a |
204 | 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> |
205 | resource in the @@RXVT_NAME@@(1) manpage). |
264 | resource in the @@RXVT_NAME@@(1) manpage). |
206 | |
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 | |
207 | =back |
288 | =back |
208 | |
289 | |
209 | =head2 Variables in the C<urxvt> Package |
290 | =head2 Variables in the C<urxvt> Package |
210 | |
291 | |
211 | =over 4 |
292 | =over 4 |
… | |
… | |
218 | =back |
299 | =back |
219 | |
300 | |
220 | =head2 Functions in the C<urxvt> Package |
301 | =head2 Functions in the C<urxvt> Package |
221 | |
302 | |
222 | =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. |
223 | |
312 | |
224 | =item urxvt::fatal $errormessage |
313 | =item urxvt::fatal $errormessage |
225 | |
314 | |
226 | Fatally aborts execution with the given error message. Avoid at all |
315 | Fatally aborts execution with the given error message. Avoid at all |
227 | 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 |
… | |
… | |
444 | } |
533 | } |
445 | |
534 | |
446 | =head2 The C<urxvt::term> Class |
535 | =head2 The C<urxvt::term> Class |
447 | |
536 | |
448 | =over 4 |
537 | =over 4 |
|
|
538 | |
|
|
539 | =item $term->destroy |
|
|
540 | |
|
|
541 | Destroy the terminal object (close the window, free resources etc.). |
449 | |
542 | |
450 | =item $value = $term->resource ($name[, $newval]) |
543 | =item $value = $term->resource ($name[, $newval]) |
451 | |
544 | |
452 | Returns the current resource value associated with a given name and |
545 | 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> |
546 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
487 | my ($self, $name) = (shift, shift); |
580 | my ($self, $name) = (shift, shift); |
488 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
581 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
489 | goto &urxvt::term::_resource; |
582 | goto &urxvt::term::_resource; |
490 | } |
583 | } |
491 | |
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 | |
492 | =item ($row, $col) = $term->selection_mark ([$row, $col]) |
595 | =item ($row, $col) = $term->selection_mark ([$row, $col]) |
493 | |
596 | |
494 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
597 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
495 | |
598 | |
496 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
599 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
… | |
… | |
510 | #=item $term->overlay ($x, $y, $text) |
613 | #=item $term->overlay ($x, $y, $text) |
511 | # |
614 | # |
512 | #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. |
513 | # |
616 | # |
514 | #=cut |
617 | #=cut |
515 | |
618 | # |
516 | sub urxvt::term::scr_overlay { |
619 | #sub urxvt::term::scr_overlay { |
517 | die; |
|
|
518 | my ($self, $x, $y, $text) = @_; |
620 | # my ($self, $x, $y, $text) = @_; |
519 | |
621 | # |
520 | my @lines = split /\n/, $text; |
622 | # my @lines = split /\n/, $text; |
521 | |
623 | # |
522 | my $w = 0; |
624 | # my $w = 0; |
523 | for (map $self->strwidth ($_), @lines) { |
625 | # for (map $self->strwidth ($_), @lines) { |
524 | $w = $_ if $w < $_; |
626 | # $w = $_ if $w < $_; |
525 | } |
627 | # } |
526 | |
628 | # |
527 | $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
629 | # $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
528 | $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
630 | # $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
529 | } |
631 | #} |
530 | |
632 | |
531 | =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
633 | =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
532 | |
634 | |
533 | 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 |
534 | width/height. C<$rstyle> defines the initial rendition style |
636 | width/height. C<$rstyle> defines the initial rendition style |
… | |
… | |
561 | |
663 | |
562 | If hidden, display the overlay again. |
664 | If hidden, display the overlay again. |
563 | |
665 | |
564 | =back |
666 | =back |
565 | |
667 | |
566 | =item $cellwidth = $term->strwidth $string |
668 | =item $cellwidth = $term->strwidth ($string) |
567 | |
669 | |
568 | Returns the number of screen-cells this string would need. Correctly |
670 | Returns the number of screen-cells this string would need. Correctly |
569 | accounts for wide and combining characters. |
671 | accounts for wide and combining characters. |
570 | |
672 | |
571 | =item $octets = $term->locale_encode $string |
673 | =item $octets = $term->locale_encode ($string) |
572 | |
674 | |
573 | Convert the given text string into the corresponding locale encoding. |
675 | Convert the given text string into the corresponding locale encoding. |
574 | |
676 | |
575 | =item $string = $term->locale_decode $octets |
677 | =item $string = $term->locale_decode ($octets) |
576 | |
678 | |
577 | 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. |
578 | |
697 | |
579 | =item $term->tt_write ($octets) |
698 | =item $term->tt_write ($octets) |
580 | |
699 | |
581 | 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 |
582 | pass characters instead of octets, you should convert your strings first |
701 | pass characters instead of octets, you should convert your strings first |
583 | to the locale-specific encoding using C<< $term->locale_encode >>. |
702 | to the locale-specific encoding using C<< $term->locale_encode >>. |
584 | |
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 | |
585 | =item $nrow = $term->nrow |
722 | =item $terminal_rows = $term->nrow |
586 | |
723 | |
587 | =item $ncol = $term->ncol |
724 | =item $terminal_columns = $term->ncol |
588 | |
725 | |
589 | Return the number of rows/columns of the terminal window (i.e. as |
726 | =item $has_focus = $term->focus |
590 | specified by C<-geometry>, excluding any scrollback). |
|
|
591 | |
727 | |
592 | =item $nsaved = $term->nsaved |
728 | =item $is_mapped = $term->mapped |
593 | |
729 | |
594 | 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. |
595 | |
737 | |
596 | =item $view_start = $term->view_start ([$newvalue]) |
738 | =item $view_start = $term->view_start ([$newvalue]) |
597 | |
739 | |
598 | 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 |
599 | C<0>, which displays the normal terminal contents. Larger values scroll |
741 | 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 |
804 | about the logical line that row C<$row_number> is part of. It supports the |
663 | following methods: |
805 | following methods: |
664 | |
806 | |
665 | =over 4 |
807 | =over 4 |
666 | |
808 | |
667 | =item $text = $line->t |
809 | =item $text = $line->t ([$new_text]) |
668 | |
810 | |
669 | Returns the full text of the line, similar to C<ROW_t> |
811 | Returns or replaces the full text of the line, similar to C<ROW_t> |
670 | |
812 | |
671 | =item $rend = $line->r |
813 | =item $rend = $line->r ([$new_rend]) |
672 | |
814 | |
673 | Returns the full rendition array of the line, similar to C<ROW_r> |
815 | Returns or replaces the full rendition array of the line, similar to C<ROW_r> |
674 | |
816 | |
675 | =item $length = $line->l |
817 | =item $length = $line->l |
676 | |
818 | |
677 | Returns the length of the line in cells, similar to C<ROW_l>. |
819 | Returns the length of the line in cells, similar to C<ROW_l>. |
678 | |
820 | |
… | |
… | |
707 | |
849 | |
708 | bless { |
850 | bless { |
709 | term => $self, |
851 | term => $self, |
710 | beg => $beg, |
852 | beg => $beg, |
711 | end => $end, |
853 | end => $end, |
|
|
854 | ncol => $self->ncol, |
712 | len => ($end - $beg) * $self->ncol + $self->ROW_l ($end), |
855 | len => ($end - $beg) * $self->ncol + $self->ROW_l ($end), |
713 | }, urxvt::line:: |
856 | }, urxvt::line:: |
714 | } |
857 | } |
715 | |
858 | |
716 | sub urxvt::line::t { |
859 | sub urxvt::line::t { |
717 | my ($self) = @_; |
860 | my ($self) = @_; |
718 | |
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 && |
719 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
869 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
720 | 0, $self->{len} |
870 | 0, $self->{len} |
721 | } |
871 | } |
722 | |
872 | |
723 | sub urxvt::line::r { |
873 | sub urxvt::line::r { |
724 | my ($self) = @_; |
874 | my ($self) = @_; |
725 | |
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) { |
726 | my $rend = [ |
883 | my $rend = [ |
727 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
884 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
728 | ]; |
885 | ]; |
729 | $#$rend = $self->{len} - 1; |
886 | $#$rend = $self->{len} - 1; |
730 | $rend |
887 | return $rend; |
|
|
888 | } |
|
|
889 | |
|
|
890 | () |
731 | } |
891 | } |
732 | |
892 | |
733 | sub urxvt::line::beg { $_[0]{beg} } |
893 | sub urxvt::line::beg { $_[0]{beg} } |
734 | sub urxvt::line::end { $_[0]{end} } |
894 | sub urxvt::line::end { $_[0]{end} } |
735 | sub urxvt::line::l { $_[0]{len} } |
895 | sub urxvt::line::l { $_[0]{len} } |
736 | |
896 | |
737 | sub urxvt::line::offset_of { |
897 | sub urxvt::line::offset_of { |
738 | my ($self, $row, $col) = @_; |
898 | my ($self, $row, $col) = @_; |
739 | |
899 | |
740 | ($row - $self->{beg}) * $self->{term}->ncol + $col |
900 | ($row - $self->{beg}) * $self->{ncol} + $col |
741 | } |
901 | } |
742 | |
902 | |
743 | sub urxvt::line::coord_of { |
903 | sub urxvt::line::coord_of { |
744 | my ($self, $offset) = @_; |
904 | my ($self, $offset) = @_; |
745 | |
905 | |
746 | use integer; |
906 | use integer; |
747 | |
907 | |
748 | ( |
908 | ( |
749 | $offset / $self->{term}->ncol + $self->{beg}, |
909 | $offset / $self->{ncol} + $self->{beg}, |
750 | $offset % $self->{term}->ncol |
910 | $offset % $self->{ncol} |
751 | ) |
911 | ) |
752 | } |
912 | } |
753 | |
913 | |
754 | =item ($row, $col) = $line->coord_of ($offset) |
914 | =item ($row, $col) = $line->coord_of ($offset) |
755 | =item $text = $term->special_encode $string |
915 | =item $text = $term->special_encode $string |