… | |
… | |
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. |
70 | |
74 | |
71 | =item mark-urls |
75 | =item example-filter-input |
72 | |
76 | |
73 | A not very useful example of filtering all text output to the terminal, by |
77 | A not very useful example of filtering all text output to the terminal, by |
74 | underlining all urls that matches a certain regex (i.e. some urls :). It |
78 | underlining all urls that matches a certain regex (i.e. some urls :). It |
75 | is not very useful because urls that are output in multiple steps (e.g. |
79 | is not very useful because urls that are output in multiple steps (e.g. |
76 | when typing them) do not get marked. |
80 | when typing them) do not get marked. |
… | |
… | |
133 | =over 4 |
137 | =over 4 |
134 | |
138 | |
135 | =item on_init $term |
139 | =item on_init $term |
136 | |
140 | |
137 | Called after a new terminal object has been initialized, but before |
141 | Called after a new terminal object has been initialized, but before |
138 | 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. |
139 | |
146 | |
140 | =item on_reset $term |
147 | =item on_reset $term |
141 | |
148 | |
142 | 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 |
143 | 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 |
… | |
… | |
223 | can filter/change and output the text yourself by returning a true value |
230 | can filter/change and output the text yourself by returning a true value |
224 | and calling C<< $term->scr_add_lines >> yourself. Please note that this |
231 | and calling C<< $term->scr_add_lines >> yourself. Please note that this |
225 | might be very slow, however, as your hook is called for B<all> text being |
232 | might be very slow, however, as your hook is called for B<all> text being |
226 | output. |
233 | output. |
227 | |
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 | |
228 | =item on_refresh_begin $term |
249 | =item on_refresh_begin $term |
229 | |
250 | |
230 | 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 |
231 | or similar effects by modify terminal contents in refresh_begin, and |
252 | or similar effects by modify terminal contents in refresh_begin, and |
232 | 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 |
… | |
… | |
240 | |
261 | |
241 | Called whenever the user presses a key combination that has a |
262 | Called whenever the user presses a key combination that has a |
242 | 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> |
243 | resource in the @@RXVT_NAME@@(1) manpage). |
264 | resource in the @@RXVT_NAME@@(1) manpage). |
244 | |
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 | |
245 | =back |
288 | =back |
246 | |
289 | |
247 | =head2 Variables in the C<urxvt> Package |
290 | =head2 Variables in the C<urxvt> Package |
248 | |
291 | |
249 | =over 4 |
292 | =over 4 |
… | |
… | |
256 | =back |
299 | =back |
257 | |
300 | |
258 | =head2 Functions in the C<urxvt> Package |
301 | =head2 Functions in the C<urxvt> Package |
259 | |
302 | |
260 | =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. |
261 | |
312 | |
262 | =item urxvt::fatal $errormessage |
313 | =item urxvt::fatal $errormessage |
263 | |
314 | |
264 | Fatally aborts execution with the given error message. Avoid at all |
315 | Fatally aborts execution with the given error message. Avoid at all |
265 | 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 |
… | |
… | |
482 | } |
533 | } |
483 | |
534 | |
484 | =head2 The C<urxvt::term> Class |
535 | =head2 The C<urxvt::term> Class |
485 | |
536 | |
486 | =over 4 |
537 | =over 4 |
|
|
538 | |
|
|
539 | =item $term->destroy |
|
|
540 | |
|
|
541 | Destroy the terminal object (close the window, free resources etc.). |
487 | |
542 | |
488 | =item $value = $term->resource ($name[, $newval]) |
543 | =item $value = $term->resource ($name[, $newval]) |
489 | |
544 | |
490 | Returns the current resource value associated with a given name and |
545 | Returns the current resource value associated with a given name and |
491 | 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> |
… | |
… | |
632 | |
687 | |
633 | Normally its not a good idea to use this function, as programs might be |
688 | Normally its not a good idea to use this function, as programs might be |
634 | confused by changes in cursor position or scrolling. Its useful inside a |
689 | confused by changes in cursor position or scrolling. Its useful inside a |
635 | C<on_add_lines> hook, though. |
690 | C<on_add_lines> hook, though. |
636 | |
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. |
|
|
697 | |
637 | =item $term->tt_write ($octets) |
698 | =item $term->tt_write ($octets) |
638 | |
699 | |
639 | 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 |
640 | pass characters instead of octets, you should convert your strings first |
701 | pass characters instead of octets, you should convert your strings first |
641 | to the locale-specific encoding using C<< $term->locale_encode >>. |
702 | to the locale-specific encoding using C<< $term->locale_encode >>. |
… | |
… | |
735 | about the logical line that row C<$row_number> is part of. It supports the |
796 | about the logical line that row C<$row_number> is part of. It supports the |
736 | following methods: |
797 | following methods: |
737 | |
798 | |
738 | =over 4 |
799 | =over 4 |
739 | |
800 | |
740 | =item $text = $line->t |
801 | =item $text = $line->t ([$new_text]) |
741 | |
802 | |
742 | Returns the full text of the line, similar to C<ROW_t> |
803 | Returns or replaces the full text of the line, similar to C<ROW_t> |
743 | |
804 | |
744 | =item $rend = $line->r |
805 | =item $rend = $line->r ([$new_rend]) |
745 | |
806 | |
746 | Returns the full rendition array of the line, similar to C<ROW_r> |
807 | Returns or replaces the full rendition array of the line, similar to C<ROW_r> |
747 | |
808 | |
748 | =item $length = $line->l |
809 | =item $length = $line->l |
749 | |
810 | |
750 | Returns the length of the line in cells, similar to C<ROW_l>. |
811 | Returns the length of the line in cells, similar to C<ROW_l>. |
751 | |
812 | |
… | |
… | |
780 | |
841 | |
781 | bless { |
842 | bless { |
782 | term => $self, |
843 | term => $self, |
783 | beg => $beg, |
844 | beg => $beg, |
784 | end => $end, |
845 | end => $end, |
|
|
846 | ncol => $self->ncol, |
785 | len => ($end - $beg) * $self->ncol + $self->ROW_l ($end), |
847 | len => ($end - $beg) * $self->ncol + $self->ROW_l ($end), |
786 | }, urxvt::line:: |
848 | }, urxvt::line:: |
787 | } |
849 | } |
788 | |
850 | |
789 | sub urxvt::line::t { |
851 | sub urxvt::line::t { |
790 | my ($self) = @_; |
852 | my ($self) = @_; |
791 | |
853 | |
|
|
854 | if (@_ > 1) |
|
|
855 | { |
|
|
856 | $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
|
|
857 | for $self->{beg} .. $self->{end}; |
|
|
858 | } |
|
|
859 | |
|
|
860 | defined wantarray && |
792 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
861 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
793 | 0, $self->{len} |
862 | 0, $self->{len} |
794 | } |
863 | } |
795 | |
864 | |
796 | sub urxvt::line::r { |
865 | sub urxvt::line::r { |
797 | my ($self) = @_; |
866 | my ($self) = @_; |
798 | |
867 | |
|
|
868 | if (@_ > 1) |
|
|
869 | { |
|
|
870 | $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
|
|
871 | for $self->{beg} .. $self->{end}; |
|
|
872 | } |
|
|
873 | |
|
|
874 | if (defined wantarray) { |
799 | my $rend = [ |
875 | my $rend = [ |
800 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
876 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
801 | ]; |
877 | ]; |
802 | $#$rend = $self->{len} - 1; |
878 | $#$rend = $self->{len} - 1; |
803 | $rend |
879 | return $rend; |
|
|
880 | } |
|
|
881 | |
|
|
882 | () |
804 | } |
883 | } |
805 | |
884 | |
806 | sub urxvt::line::beg { $_[0]{beg} } |
885 | sub urxvt::line::beg { $_[0]{beg} } |
807 | sub urxvt::line::end { $_[0]{end} } |
886 | sub urxvt::line::end { $_[0]{end} } |
808 | sub urxvt::line::l { $_[0]{len} } |
887 | sub urxvt::line::l { $_[0]{len} } |
809 | |
888 | |
810 | sub urxvt::line::offset_of { |
889 | sub urxvt::line::offset_of { |
811 | my ($self, $row, $col) = @_; |
890 | my ($self, $row, $col) = @_; |
812 | |
891 | |
813 | ($row - $self->{beg}) * $self->{term}->ncol + $col |
892 | ($row - $self->{beg}) * $self->{ncol} + $col |
814 | } |
893 | } |
815 | |
894 | |
816 | sub urxvt::line::coord_of { |
895 | sub urxvt::line::coord_of { |
817 | my ($self, $offset) = @_; |
896 | my ($self, $offset) = @_; |
818 | |
897 | |
819 | use integer; |
898 | use integer; |
820 | |
899 | |
821 | ( |
900 | ( |
822 | $offset / $self->{term}->ncol + $self->{beg}, |
901 | $offset / $self->{ncol} + $self->{beg}, |
823 | $offset % $self->{term}->ncol |
902 | $offset % $self->{ncol} |
824 | ) |
903 | ) |
825 | } |
904 | } |
826 | |
905 | |
827 | =item ($row, $col) = $line->coord_of ($offset) |
906 | =item ($row, $col) = $line->coord_of ($offset) |
828 | =item $text = $term->special_encode $string |
907 | =item $text = $term->special_encode $string |