ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/urxvt.pm
(Generate patch)

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.31 by root, Wed Jan 4 19:39:46 2006 UTC vs.
Revision 1.42 by root, Fri Jan 6 21:06:09 2006 UTC

… …
59=back 59=back
60 60
61=item digital-clock 61=item digital-clock
62 62
63Displays a digital clock using the built-in overlay. 63Displays a digital clock using the built-in overlay.
64
65=item mark-urls
66
67Uses per-line display filtering (C<on_line_update>) to underline urls.
68
69=item block-graphics-to-ascii
70
71A not very useful example of filtering all text output to the terminal,
72by replacing all line-drawing characters (U+2500 .. U+259F) by a
73similar-looking ascii character.
64 74
65=item example-refresh-hooks 75=item example-refresh-hooks
66 76
67Displays a very simple digital clock in the upper right corner of the 77Displays a very simple digital clock in the upper right corner of the
68window. Illustrates overwriting the refresh callbacks to create your own 78window. Illustrates overwriting the refresh callbacks to create your own
… …
81When objects are destroyed on the C++ side, the perl object hashes are 91When objects are destroyed on the C++ side, the perl object hashes are
82emptied, so its best to store related objects such as time watchers and 92emptied, so its best to store related objects such as time watchers and
83the like inside the terminal object so they get destroyed as soon as the 93the like inside the terminal object so they get destroyed as soon as the
84terminal is destroyed. 94terminal is destroyed.
85 95
96Argument names also often indicate the type of a parameter. Here are some
97hints on what they mean:
98
99=over 4
100
101=item $text
102
103Rxvt-unicodes special way of encoding text, where one "unicode" character
104always represents one screen cell. See L<row_t> for a discussion of this format.
105
106=item $string
107
108A perl text string, with an emphasis on I<text>. It can store all unicode
109characters and is to be distinguished with text encoded in a specific
110encoding (often locale-specific) and binary data.
111
112=item $octets
113
114Either binary data or - more common - a text string encoded in a
115locale-specific way.
116
117=back
118
86=head2 Hooks 119=head2 Hooks
87 120
88The following subroutines can be declared in loaded scripts, and will be 121The following subroutines can be declared in loaded scripts, and will be
89called whenever the relevant event happens. 122called whenever the relevant event happens.
90 123
… …
103=over 4 136=over 4
104 137
105=item on_init $term 138=item on_init $term
106 139
107Called after a new terminal object has been initialized, but before 140Called after a new terminal object has been initialized, but before
108windows are created or the command gets run. 141windows are created or the command gets run. Most methods are unsafe to
142call or deliver senseless data, as terminal size and other characteristics
143have not yet been determined. You can safely query and change resources,
144though.
109 145
110=item on_reset $term 146=item on_reset $term
111 147
112Called after the screen is "reset" for any reason, such as resizing or 148Called after the screen is "reset" for any reason, such as resizing or
113control sequences. Here is where you can react on changes to size-related 149control sequences. Here is where you can react on changes to size-related
… …
185 221
186Be careful not ever to trust (in a security sense) the data you receive, 222Be careful not ever to trust (in a security sense) the data you receive,
187as its source can not easily be controleld (e-mail content, messages from 223as its source can not easily be controleld (e-mail content, messages from
188other users on the same system etc.). 224other users on the same system etc.).
189 225
226=item on_add_lines $term, $string
227
228Called whenever text is about to be output, with the text as argument. You
229can filter/change and output the text yourself by returning a true value
230and calling C<< $term->scr_add_lines >> yourself. Please note that this
231might be very slow, however, as your hook is called for B<all> text being
232output.
233
234=item on_line_update $term, $row
235
236Called whenever a line was updated or changed. Can be used to filter
237screen output (e.g. underline urls or other useless stuff). Only lines
238that are being shown will be filtered, and, due to performance reasons,
239not always immediately.
240
241The row number is always the topmost row of the line if the line spans
242multiple rows.
243
244Please note that, if you change the line, then the hook might get called
245later with the already-modified line (e.g. if unrelated parts change), so
246you cannot just toggle rendition bits, but only set them.
247
190=item on_refresh_begin $term 248=item on_refresh_begin $term
191 249
192Called just before the screen gets redrawn. Can be used for overlay 250Called just before the screen gets redrawn. Can be used for overlay
193or similar effects by modify terminal contents in refresh_begin, and 251or similar effects by modify terminal contents in refresh_begin, and
194restoring them in refresh_end. The built-in overlay and selection display 252restoring them in refresh_end. The built-in overlay and selection display
… …
202 260
203Called whenever the user presses a key combination that has a 261Called whenever the user presses a key combination that has a
204C<perl:string> action bound to it (see description of the B<keysym> 262C<perl:string> action bound to it (see description of the B<keysym>
205resource in the @@RXVT_NAME@@(1) manpage). 263resource in the @@RXVT_NAME@@(1) manpage).
206 264
265=item on_key_press $term, $event, $octets
266
267=item on_key_release $term, $event
268
269=item on_button_press $term, $event
270
271=item on_button_release $term, $event
272
273=item on_motion_notify $term, $event
274
275Called whenever the corresponding X event is received for the terminal If
276the hook returns true, then the even will be ignored by rxvt-unicode.
277
278The event is a hash with most values as named by Xlib (see the XEvent
279manpage), with the additional members C<row> and C<col>, which are the row
280and column under the mouse cursor.
281
282C<on_key_press> additionally receives the string rxvt-unicode would
283output, if any, in locale-specific encoding.
284
285subwindow.
286
207=back 287=back
208 288
209=head2 Variables in the C<urxvt> Package 289=head2 Variables in the C<urxvt> Package
210 290
211=over 4 291=over 4
… …
218=back 298=back
219 299
220=head2 Functions in the C<urxvt> Package 300=head2 Functions in the C<urxvt> Package
221 301
222=over 4 302=over 4
303
304=item $term = new urxvt [arg...]
305
306Creates a new terminal, very similar as if you had started it with
307C<system $binfile, arg...>. Croaks (and probably outputs an error message)
308if the new instance couldn't be created. Returns C<undef> if the new
309instance didn't initialise perl, and the terminal object otherwise. The
310C<init> and C<start> hooks will be called during the call.
223 311
224=item urxvt::fatal $errormessage 312=item urxvt::fatal $errormessage
225 313
226Fatally aborts execution with the given error message. Avoid at all 314Fatally aborts execution with the given error message. Avoid at all
227costs! The only time this is acceptable is when the terminal process 315costs! The only time this is acceptable is when the terminal process
… …
376 my $htype = shift; 464 my $htype = shift;
377 465
378 if ($htype == 0) { # INIT 466 if ($htype == 0) { # INIT
379 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 467 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
380 468
381 for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) { 469 for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
382 my @files = grep -f $_, map "$_/$ext", @dirs; 470 my @files = grep -f $_, map "$_/$ext", @dirs;
383 471
384 if (@files) { 472 if (@files) {
385 register_package script_package $files[0]; 473 register_package script_package $files[0];
386 } else { 474 } else {
… …
444} 532}
445 533
446=head2 The C<urxvt::term> Class 534=head2 The C<urxvt::term> Class
447 535
448=over 4 536=over 4
537
538=item $term->destroy
539
540Destroy the terminal object (close the window, free resources etc.).
449 541
450=item $value = $term->resource ($name[, $newval]) 542=item $value = $term->resource ($name[, $newval])
451 543
452Returns the current resource value associated with a given name and 544Returns the current resource value associated with a given name and
453optionally sets a new value. Setting values is most useful in the C<init> 545optionally sets a new value. Setting values is most useful in the C<init>
… …
487 my ($self, $name) = (shift, shift); 579 my ($self, $name) = (shift, shift);
488 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 580 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
489 goto &urxvt::term::_resource; 581 goto &urxvt::term::_resource;
490} 582}
491 583
584=item $rend = $term->rstyle ([$new_rstyle])
585
586Return and optionally change the current rendition. Text that is output by
587the terminal application will use this style.
588
589=item ($row, $col) = $term->screen_cur ([$row, $col])
590
591Return the current coordinates of the text cursor position and optionally
592set it (which is usually bad as applications don't expect that).
593
492=item ($row, $col) = $term->selection_mark ([$row, $col]) 594=item ($row, $col) = $term->selection_mark ([$row, $col])
493 595
494=item ($row, $col) = $term->selection_beg ([$row, $col]) 596=item ($row, $col) = $term->selection_beg ([$row, $col])
495 597
496=item ($row, $col) = $term->selection_end ([$row, $col]) 598=item ($row, $col) = $term->selection_end ([$row, $col])
… …
510#=item $term->overlay ($x, $y, $text) 612#=item $term->overlay ($x, $y, $text)
511# 613#
512#Create a simple multi-line overlay box. See the next method for details. 614#Create a simple multi-line overlay box. See the next method for details.
513# 615#
514#=cut 616#=cut
515 617#
516sub urxvt::term::scr_overlay { 618#sub urxvt::term::scr_overlay {
517die;
518 my ($self, $x, $y, $text) = @_; 619# my ($self, $x, $y, $text) = @_;
519 620#
520 my @lines = split /\n/, $text; 621# my @lines = split /\n/, $text;
521 622#
522 my $w = 0; 623# my $w = 0;
523 for (map $self->strwidth ($_), @lines) { 624# for (map $self->strwidth ($_), @lines) {
524 $w = $_ if $w < $_; 625# $w = $_ if $w < $_;
525 } 626# }
526 627#
527 $self->scr_overlay_new ($x, $y, $w, scalar @lines); 628# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
528 $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; 629# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
529} 630#}
530 631
531=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) 632=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
532 633
533Create a new (empty) overlay at the given position with the given 634Create a new (empty) overlay at the given position with the given
534width/height. C<$rstyle> defines the initial rendition style 635width/height. C<$rstyle> defines the initial rendition style
… …
561 662
562If hidden, display the overlay again. 663If hidden, display the overlay again.
563 664
564=back 665=back
565 666
566=item $cellwidth = $term->strwidth $string 667=item $cellwidth = $term->strwidth ($string)
567 668
568Returns the number of screen-cells this string would need. Correctly 669Returns the number of screen-cells this string would need. Correctly
569accounts for wide and combining characters. 670accounts for wide and combining characters.
570 671
571=item $octets = $term->locale_encode $string 672=item $octets = $term->locale_encode ($string)
572 673
573Convert the given text string into the corresponding locale encoding. 674Convert the given text string into the corresponding locale encoding.
574 675
575=item $string = $term->locale_decode $octets 676=item $string = $term->locale_decode ($octets)
576 677
577Convert the given locale-encoded octets into a perl string. 678Convert the given locale-encoded octets into a perl string.
679
680=item $term->scr_add_lines ($string)
681
682Write the given text string to the screen, as if output by the application
683running inside the terminal. It may not contain command sequences (escape
684codes), but is free to use line feeds, carriage returns and tabs. The
685string is a normal text string, not in locale-dependent encoding.
686
687Normally its not a good idea to use this function, as programs might be
688confused by changes in cursor position or scrolling. Its useful inside a
689C<on_add_lines> hook, though.
690
691=item $term->cmd_parse ($octets)
692
693Similar to C<scr_add_lines>, but the argument must be in the
694locale-specific encoding of the terminal and can contain command sequences
695(escape codes) that will be interpreted.
578 696
579=item $term->tt_write ($octets) 697=item $term->tt_write ($octets)
580 698
581Write the octets given in C<$data> to the tty (i.e. as program input). To 699Write the octets given in C<$data> to the tty (i.e. as program input). To
582pass characters instead of octets, you should convert your strings first 700pass characters instead of octets, you should convert your strings first
583to the locale-specific encoding using C<< $term->locale_encode >>. 701to the locale-specific encoding using C<< $term->locale_encode >>.
584 702
703=item $windowid = $term->parent
704
705Return the window id of the toplevel window.
706
707=item $windowid = $term->vt
708
709Return the window id of the terminal window.
710
711=item $window_width = $term->width
712
713=item $window_height = $term->height
714
715=item $font_width = $term->fwidth
716
717=item $font_height = $term->fheight
718
719=item $font_ascent = $term->fbase
720
585=item $nrow = $term->nrow 721=item $terminal_rows = $term->nrow
586 722
587=item $ncol = $term->ncol 723=item $terminal_columns = $term->ncol
588 724
589Return the number of rows/columns of the terminal window (i.e. as 725=item $has_focus = $term->focus
590specified by C<-geometry>, excluding any scrollback).
591 726
592=item $nsaved = $term->nsaved 727=item $is_mapped = $term->mapped
593 728
594Returns the number of lines in the scrollback buffer. 729=item $max_scrollback = $term->saveLines
730
731=item $nrow_plus_saveLines = $term->total_rows
732
733=item $lines_in_scrollback = $term->nsaved
734
735Return various integers describing terminal characteristics.
595 736
596=item $view_start = $term->view_start ([$newvalue]) 737=item $view_start = $term->view_start ([$newvalue])
597 738
598Returns the negative row number of the topmost line. Minimum value is 739Returns the negative row number of the topmost line. Minimum value is
599C<0>, which displays the normal terminal contents. Larger values scroll 740C<0>, which displays the normal terminal contents. Larger values scroll
… …
662about the logical line that row C<$row_number> is part of. It supports the 803about the logical line that row C<$row_number> is part of. It supports the
663following methods: 804following methods:
664 805
665=over 4 806=over 4
666 807
667=item $text = $line->t 808=item $text = $line->t ([$new_text])
668 809
669Returns the full text of the line, similar to C<ROW_t> 810Returns or replaces the full text of the line, similar to C<ROW_t>
670 811
671=item $rend = $line->r 812=item $rend = $line->r ([$new_rend])
672 813
673Returns the full rendition array of the line, similar to C<ROW_r> 814Returns or replaces the full rendition array of the line, similar to C<ROW_r>
674 815
675=item $length = $line->l 816=item $length = $line->l
676 817
677Returns the length of the line in cells, similar to C<ROW_l>. 818Returns the length of the line in cells, similar to C<ROW_l>.
678 819
… …
707 848
708 bless { 849 bless {
709 term => $self, 850 term => $self,
710 beg => $beg, 851 beg => $beg,
711 end => $end, 852 end => $end,
853 ncol => $self->ncol,
712 len => ($end - $beg) * $self->ncol + $self->ROW_l ($end), 854 len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
713 }, urxvt::line:: 855 }, urxvt::line::
714} 856}
715 857
716sub urxvt::line::t { 858sub urxvt::line::t {
717 my ($self) = @_; 859 my ($self) = @_;
718 860
861 if (@_ > 1)
862 {
863 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
864 for $self->{beg} .. $self->{end};
865 }
866
867 defined wantarray &&
719 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), 868 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
720 0, $self->{len} 869 0, $self->{len}
721} 870}
722 871
723sub urxvt::line::r { 872sub urxvt::line::r {
724 my ($self) = @_; 873 my ($self) = @_;
725 874
875 if (@_ > 1)
876 {
877 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
878 for $self->{beg} .. $self->{end};
879 }
880
881 if (defined wantarray) {
726 my $rend = [ 882 my $rend = [
727 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} 883 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
728 ]; 884 ];
729 $#$rend = $self->{len} - 1; 885 $#$rend = $self->{len} - 1;
730 $rend 886 return $rend;
887 }
888
889 ()
731} 890}
732 891
733sub urxvt::line::beg { $_[0]{beg} } 892sub urxvt::line::beg { $_[0]{beg} }
734sub urxvt::line::end { $_[0]{end} } 893sub urxvt::line::end { $_[0]{end} }
735sub urxvt::line::l { $_[0]{len} } 894sub urxvt::line::l { $_[0]{len} }
736 895
737sub urxvt::line::offset_of { 896sub urxvt::line::offset_of {
738 my ($self, $row, $col) = @_; 897 my ($self, $row, $col) = @_;
739 898
740 ($row - $self->{beg}) * $self->{term}->ncol + $col 899 ($row - $self->{beg}) * $self->{ncol} + $col
741} 900}
742 901
743sub urxvt::line::coord_of { 902sub urxvt::line::coord_of {
744 my ($self, $offset) = @_; 903 my ($self, $offset) = @_;
745 904
746 use integer; 905 use integer;
747 906
748 ( 907 (
749 $offset / $self->{term}->ncol + $self->{beg}, 908 $offset / $self->{ncol} + $self->{beg},
750 $offset % $self->{term}->ncol 909 $offset % $self->{ncol}
751 ) 910 )
752} 911}
753 912
754=item ($row, $col) = $line->coord_of ($offset) 913=item ($row, $col) = $line->coord_of ($offset)
755=item $text = $term->special_encode $string 914=item $text = $term->special_encode $string

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines