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.29 by root, Wed Jan 4 00:12:12 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
366 454
367 $pkg 455 $pkg
368 } 456 }
369} 457}
370 458
459our $retval; # return value for urxvt
460
371# called by the rxvt core 461# called by the rxvt core
372sub invoke { 462sub invoke {
373 local $TERM = shift; 463 local $TERM = shift;
374 my $htype = shift; 464 my $htype = shift;
375 465
376 if ($htype == 0) { # INIT 466 if ($htype == 0) { # INIT
377 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 467 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
378 468
379 for my $ext (split /:/, $TERM->resource ("perl_ext")) { 469 for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
380 my @files = grep -f $_, map "$_/$ext", @dirs; 470 my @files = grep -f $_, map "$_/$ext", @dirs;
381 471
382 if (@files) { 472 if (@files) {
383 register_package script_package $files[0]; 473 register_package script_package $files[0];
384 } else { 474 } else {
385 warn "perl extension '$ext' not found in perl library search path\n"; 475 warn "perl extension '$ext' not found in perl library search path\n";
386 } 476 }
387 } 477 }
478 }
388 479
480 $retval = undef;
481
482 if (my $cb = $TERM->{_hook}[$htype]) {
483 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
484 if $verbosity >= 10;
485
486 keys %$cb;
487
488 while (my ($pkg, $cb) = each %$cb) {
489 $retval = $cb->(
490 $TERM->{_pkg}{$pkg} ||= do {
491 my $proxy = bless { }, urxvt::term::proxy::;
492 Scalar::Util::weaken ($proxy->{term} = $TERM);
493 $proxy
494 },
495 @_,
496 ) and last;
497 }
498 }
499
389 } elsif ($htype == 1) { # DESTROY 500 if ($htype == 1) { # DESTROY
501 # remove hooks if unused
390 if (my $hook = $TERM->{_hook}) { 502 if (my $hook = $TERM->{_hook}) {
391 for my $htype (0..$#$hook) { 503 for my $htype (0..$#$hook) {
392 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } 504 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
393 or set_should_invoke $htype, 0; 505 or set_should_invoke $htype, 0;
394 } 506 }
395 } 507 }
508
509 # clear package objects
510 %$_ = () for values %{ $TERM->{_pkg} };
511
512 # clear package
513 %$TERM = ();
396 } 514 }
397 515
398 my $cb = $TERM->{_hook}[$htype] 516 $retval
399 or return;
400
401 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
402 if $verbosity >= 10;
403
404 keys %$cb;
405
406 while (my ($pkg, $cb) = each %$cb) {
407 return 1
408 if $cb->(
409 $TERM->{$pkg} ||= do {
410 my $proxy = bless { }, urxvt::term::proxy::;
411 Scalar::Util::weaken ($proxy->{term} = $TERM);
412 $proxy
413 },
414 @_,
415 );
416 }
417
418 0
419} 517}
420 518
421sub urxvt::term::proxy::AUTOLOAD { 519sub urxvt::term::proxy::AUTOLOAD {
422 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 520 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
423 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 521 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
435 533
436=head2 The C<urxvt::term> Class 534=head2 The C<urxvt::term> Class
437 535
438=over 4 536=over 4
439 537
538=item $term->destroy
539
540Destroy the terminal object (close the window, free resources etc.).
541
440=item $value = $term->resource ($name[, $newval]) 542=item $value = $term->resource ($name[, $newval])
441 543
442Returns the current resource value associated with a given name and 544Returns the current resource value associated with a given name and
443optionally 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>
444hook. Unset resources are returned and accepted as C<undef>. 546hook. Unset resources are returned and accepted as C<undef>.
461 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 563 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
462 borderLess color cursorBlink cursorUnderline cutchars delete_key 564 borderLess color cursorBlink cursorUnderline cutchars delete_key
463 display_name embed ext_bwidth fade font geometry hold iconName 565 display_name embed ext_bwidth fade font geometry hold iconName
464 imFont imLocale inputMethod insecure int_bwidth intensityStyles 566 imFont imLocale inputMethod insecure int_bwidth intensityStyles
465 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 567 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
466 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext 568 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
467 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 569 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
468 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 570 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
469 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 571 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
470 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 572 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
471 shade term_name title transparent transparent_all tripleclickwords 573 shade term_name title transparent transparent_all tripleclickwords
477 my ($self, $name) = (shift, shift); 579 my ($self, $name) = (shift, shift);
478 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 580 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
479 goto &urxvt::term::_resource; 581 goto &urxvt::term::_resource;
480} 582}
481 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
482=item ($row, $col) = $term->selection_mark ([$row, $col]) 594=item ($row, $col) = $term->selection_mark ([$row, $col])
483 595
484=item ($row, $col) = $term->selection_beg ([$row, $col]) 596=item ($row, $col) = $term->selection_beg ([$row, $col])
485 597
486=item ($row, $col) = $term->selection_end ([$row, $col]) 598=item ($row, $col) = $term->selection_end ([$row, $col])
500#=item $term->overlay ($x, $y, $text) 612#=item $term->overlay ($x, $y, $text)
501# 613#
502#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.
503# 615#
504#=cut 616#=cut
505 617#
506sub urxvt::term::scr_overlay { 618#sub urxvt::term::scr_overlay {
507die;
508 my ($self, $x, $y, $text) = @_; 619# my ($self, $x, $y, $text) = @_;
509 620#
510 my @lines = split /\n/, $text; 621# my @lines = split /\n/, $text;
511 622#
512 my $w = 0; 623# my $w = 0;
513 for (map $self->strwidth ($_), @lines) { 624# for (map $self->strwidth ($_), @lines) {
514 $w = $_ if $w < $_; 625# $w = $_ if $w < $_;
515 } 626# }
516 627#
517 $self->scr_overlay_new ($x, $y, $w, scalar @lines); 628# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
518 $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; 629# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
519} 630#}
520 631
521=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) 632=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
522 633
523Create a new (empty) overlay at the given position with the given 634Create a new (empty) overlay at the given position with the given
524width/height. C<$rstyle> defines the initial rendition style 635width/height. C<$rstyle> defines the initial rendition style
551 662
552If hidden, display the overlay again. 663If hidden, display the overlay again.
553 664
554=back 665=back
555 666
556=item $cellwidth = $term->strwidth $string 667=item $cellwidth = $term->strwidth ($string)
557 668
558Returns the number of screen-cells this string would need. Correctly 669Returns the number of screen-cells this string would need. Correctly
559accounts for wide and combining characters. 670accounts for wide and combining characters.
560 671
561=item $octets = $term->locale_encode $string 672=item $octets = $term->locale_encode ($string)
562 673
563Convert the given text string into the corresponding locale encoding. 674Convert the given text string into the corresponding locale encoding.
564 675
565=item $string = $term->locale_decode $octets 676=item $string = $term->locale_decode ($octets)
566 677
567Convert 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.
568 696
569=item $term->tt_write ($octets) 697=item $term->tt_write ($octets)
570 698
571Write 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
572pass characters instead of octets, you should convert your strings first 700pass characters instead of octets, you should convert your strings first
573to the locale-specific encoding using C<< $term->locale_encode >>. 701to the locale-specific encoding using C<< $term->locale_encode >>.
574 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
575=item $nrow = $term->nrow 721=item $terminal_rows = $term->nrow
576 722
577=item $ncol = $term->ncol 723=item $terminal_columns = $term->ncol
578 724
579Return the number of rows/columns of the terminal window (i.e. as 725=item $has_focus = $term->focus
580specified by C<-geometry>, excluding any scrollback).
581 726
582=item $nsaved = $term->nsaved 727=item $is_mapped = $term->mapped
583 728
584Returns 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.
585 736
586=item $view_start = $term->view_start ([$newvalue]) 737=item $view_start = $term->view_start ([$newvalue])
587 738
588Returns the negative row number of the topmost line. Minimum value is 739Returns the negative row number of the topmost line. Minimum value is
589C<0>, which displays the normal terminal contents. Larger values scroll 740C<0>, which displays the normal terminal contents. Larger values scroll
652about 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
653following methods: 804following methods:
654 805
655=over 4 806=over 4
656 807
657=item $text = $line->t 808=item $text = $line->t ([$new_text])
658 809
659Returns 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>
660 811
661=item $rend = $line->r 812=item $rend = $line->r ([$new_rend])
662 813
663Returns 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>
664 815
665=item $length = $line->l 816=item $length = $line->l
666 817
667Returns 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>.
668 819
697 848
698 bless { 849 bless {
699 term => $self, 850 term => $self,
700 beg => $beg, 851 beg => $beg,
701 end => $end, 852 end => $end,
853 ncol => $self->ncol,
702 len => ($end - $beg) * $self->ncol + $self->ROW_l ($end), 854 len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
703 }, urxvt::line:: 855 }, urxvt::line::
704} 856}
705 857
706sub urxvt::line::t { 858sub urxvt::line::t {
707 my ($self) = @_; 859 my ($self) = @_;
708 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 &&
709 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), 868 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
710 0, $self->{len} 869 0, $self->{len}
711} 870}
712 871
713sub urxvt::line::r { 872sub urxvt::line::r {
714 my ($self) = @_; 873 my ($self) = @_;
715 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) {
716 my $rend = [ 882 my $rend = [
717 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} 883 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
718 ]; 884 ];
719 $#$rend = $self->{len} - 1; 885 $#$rend = $self->{len} - 1;
720 $rend 886 return $rend;
887 }
888
889 ()
721} 890}
722 891
723sub urxvt::line::beg { $_[0]{beg} } 892sub urxvt::line::beg { $_[0]{beg} }
724sub urxvt::line::end { $_[0]{end} } 893sub urxvt::line::end { $_[0]{end} }
725sub urxvt::line::l { $_[0]{len} } 894sub urxvt::line::l { $_[0]{len} }
726 895
727sub urxvt::line::offset_of { 896sub urxvt::line::offset_of {
728 my ($self, $row, $col) = @_; 897 my ($self, $row, $col) = @_;
729 898
730 ($row - $self->{beg}) * $self->{term}->ncol + $col 899 ($row - $self->{beg}) * $self->{ncol} + $col
731} 900}
732 901
733sub urxvt::line::coord_of { 902sub urxvt::line::coord_of {
734 my ($self, $offset) = @_; 903 my ($self, $offset) = @_;
735 904
736 use integer; 905 use integer;
737 906
738 ( 907 (
739 $offset / $self->{term}->ncol + $self->{beg}, 908 $offset / $self->{ncol} + $self->{beg},
740 $offset % $self->{term}->ncol 909 $offset % $self->{ncol}
741 ) 910 )
742} 911}
743 912
744=item ($row, $col) = $line->coord_of ($offset) 913=item ($row, $col) = $line->coord_of ($offset)
745=item $text = $term->special_encode $string 914=item $text = $term->special_encode $string

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines