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.23 by root, Tue Jan 3 19:42:53 2006 UTC vs.
Revision 1.30 by root, Wed Jan 4 05:35:34 2006 UTC

39 39
40=over 4 40=over 4
41 41
42=item selection 42=item selection
43 43
44Intelligent selection. This etxension tries to be more intelligent when the user 44Intelligent selection. This extension tries to be more intelligent when
45extends selections (double-click). 45the user extends selections (double-click). Right now, it tries to select
46urls and complete shell-quoted arguments, which is very convenient, too,
47if your F<ls> supports C<--quoting-style=shell>.
46 48
47It also offers the following bindable event: 49It also offers the following bindable event:
48 50
49=over 4 51=over 4
50 52
169number of lines that will be in the scrollback buffer. 171number of lines that will be in the scrollback buffer.
170 172
171=item on_tty_activity $term *NYI* 173=item on_tty_activity $term *NYI*
172 174
173Called whenever the program(s) running in the urxvt window send output. 175Called whenever the program(s) running in the urxvt window send output.
176
177=item on_osc_seq $term, $string
178
179Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
180operating system command) is processed. Cursor position and other state
181information is up-to-date when this happens. For interoperability, the
182string should start with the extension name and a colon, to distinguish
183it from commands for other extensions, and this might be enforced in the
184future.
185
186Be 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
188other users on the same system etc.).
174 189
175=item on_refresh_begin $term 190=item on_refresh_begin $term
176 191
177Called just before the screen gets redrawn. Can be used for overlay 192Called just before the screen gets redrawn. Can be used for overlay
178or similar effects by modify terminal contents in refresh_begin, and 193or similar effects by modify terminal contents in refresh_begin, and
359 my $htype = shift; 374 my $htype = shift;
360 375
361 if ($htype == 0) { # INIT 376 if ($htype == 0) { # INIT
362 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 377 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
363 378
364 for my $ext (split /:/, $TERM->resource ("perl_ext")) { 379 for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {
365 my @files = grep -f $_, map "$_/$ext", @dirs; 380 my @files = grep -f $_, map "$_/$ext", @dirs;
366 381
367 if (@files) { 382 if (@files) {
368 register_package script_package $files[0]; 383 register_package script_package $files[0];
369 } else { 384 } else {
383 my $cb = $TERM->{_hook}[$htype] 398 my $cb = $TERM->{_hook}[$htype]
384 or return; 399 or return;
385 400
386 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 401 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
387 if $verbosity >= 10; 402 if $verbosity >= 10;
403
404 keys %$cb;
388 405
389 while (my ($pkg, $cb) = each %$cb) { 406 while (my ($pkg, $cb) = each %$cb) {
390 return 1 407 return 1
391 if $cb->( 408 if $cb->(
392 $TERM->{$pkg} ||= do { 409 $TERM->{$pkg} ||= do {
405 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 422 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
406 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 423 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
407 424
408 eval qq{ 425 eval qq{
409 sub $urxvt::term::proxy::AUTOLOAD { 426 sub $urxvt::term::proxy::AUTOLOAD {
410 unshift \@_, shift->{term}; 427 my \$proxy = shift;
411 goto &urxvt::term::$1; 428 \$proxy->{term}->$1 (\@_)
412 } 429 }
413 1 430 1
414 } or die "FATAL: unable to compile method forwarder: $@"; 431 } or die "FATAL: unable to compile method forwarder: $@";
415 432
416 goto &$urxvt::term::proxy::AUTOLOAD; 433 goto &$urxvt::term::proxy::AUTOLOAD;
444 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 461 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
445 borderLess color cursorBlink cursorUnderline cutchars delete_key 462 borderLess color cursorBlink cursorUnderline cutchars delete_key
446 display_name embed ext_bwidth fade font geometry hold iconName 463 display_name embed ext_bwidth fade font geometry hold iconName
447 imFont imLocale inputMethod insecure int_bwidth intensityStyles 464 imFont imLocale inputMethod insecure int_bwidth intensityStyles
448 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 465 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
449 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext 466 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
450 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 467 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
451 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 468 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
452 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 469 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
453 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 470 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
454 shade term_name title transparent transparent_all tripleclickwords 471 shade term_name title transparent transparent_all tripleclickwords
583=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 600=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
584 601
585Returns the text of the entire row with number C<$row_number>. Row C<0> 602Returns the text of the entire row with number C<$row_number>. Row C<0>
586is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 603is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
587terminal line. The scrollback buffer starts at line C<-1> and extends to 604terminal line. The scrollback buffer starts at line C<-1> and extends to
588line C<< -$term->nsaved >>. 605line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
606is requested.
589 607
590If C<$new_text> is specified, it will replace characters in the current 608If C<$new_text> is specified, it will replace characters in the current
591line, starting at column C<$start_col> (default C<0>), which is useful 609line, starting at column C<$start_col> (default C<0>), which is useful
592to replace only parts of a line. The font index in the rendition will 610to replace only parts of a line. The font index in the rendition will
593automatically be updated. 611automatically be updated.
615 633
616See the section on RENDITION, above. 634See the section on RENDITION, above.
617 635
618=item $length = $term->ROW_l ($row_number[, $new_length]) 636=item $length = $term->ROW_l ($row_number[, $new_length])
619 637
620Returns the number of screen cells that are in use ("the line length"). If 638Returns the number of screen cells that are in use ("the line
621it is C<-1>, then the line is part of a multiple-row logical "line", which 639length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
622means all characters are in use and it is continued on the next row. 640line is joined with the following one.
623 641
642=item $bool = $term->is_longer ($row_number)
643
644Returns true if the row is part of a multiple-row logical "line" (i.e.
645joined with the following row), which means all characters are in use
646and it is continued on the next row (and possibly a continuation of the
647previous row(s)).
648
649=item $line = $term->line ($row_number)
650
651Create and return a new C<urxvt::line> object that stores information
652about the logical line that row C<$row_number> is part of. It supports the
653following methods:
654
655=over 4
656
657=item $text = $line->t
658
659Returns the full text of the line, similar to C<ROW_t>
660
661=item $rend = $line->r
662
663Returns the full rendition array of the line, similar to C<ROW_r>
664
665=item $length = $line->l
666
667Returns the length of the line in cells, similar to C<ROW_l>.
668
669=item $rownum = $line->beg
670
671=item $rownum = $line->end
672
673Return the row number of the first/last row of the line, respectively.
674
675=item $offset = $line->offset_of ($row, $col)
676
677Returns the character offset of the given row|col pair within the logical
678line.
679
680=item ($row, $col) = $line->coord_of ($offset)
681
682Translates a string offset into terminal coordinates again.
683
684=back
685
686=cut
687
688sub urxvt::term::line {
689 my ($self, $row) = @_;
690
691 my $maxrow = $self->nrow - 1;
692
693 my ($beg, $end) = ($row, $row);
694
695 --$beg while $self->ROW_is_longer ($beg - 1);
696 ++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
697
698 bless {
699 term => $self,
700 beg => $beg,
701 end => $end,
702 len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
703 }, urxvt::line::
704}
705
706sub urxvt::line::t {
707 my ($self) = @_;
708
709 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
710 0, $self->{len}
711}
712
713sub urxvt::line::r {
714 my ($self) = @_;
715
716 my $rend = [
717 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
718 ];
719 $#$rend = $self->{len} - 1;
720 $rend
721}
722
723sub urxvt::line::beg { $_[0]{beg} }
724sub urxvt::line::end { $_[0]{end} }
725sub urxvt::line::l { $_[0]{len} }
726
727sub urxvt::line::offset_of {
728 my ($self, $row, $col) = @_;
729
730 ($row - $self->{beg}) * $self->{term}->ncol + $col
731}
732
733sub urxvt::line::coord_of {
734 my ($self, $offset) = @_;
735
736 use integer;
737
738 (
739 $offset / $self->{term}->ncol + $self->{beg},
740 $offset % $self->{term}->ncol
741 )
742}
743
744=item ($row, $col) = $line->coord_of ($offset)
624=item $text = $term->special_encode $string 745=item $text = $term->special_encode $string
625 746
626Converts a perl string into the special encoding used by rxvt-unicode, 747Converts a perl string into the special encoding used by rxvt-unicode,
627where one character corresponds to one screen cell. See 748where one character corresponds to one screen cell. See
628C<< $term->ROW_t >> for details. 749C<< $term->ROW_t >> for details.
742This variable controls the verbosity level of the perl extension. Higher 863This variable controls the verbosity level of the perl extension. Higher
743numbers indicate more verbose output. 864numbers indicate more verbose output.
744 865
745=over 4 866=over 4
746 867
747=item 0 - only fatal messages 868=item =0 - only fatal messages
748 869
749=item 3 - script loading and management 870=item =3 - script loading and management
750 871
751=item 10 - all events received 872=item =10 - all events received
752 873
753=back 874=back
754 875
755=head1 AUTHOR 876=head1 AUTHOR
756 877

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines