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.32 by root, Wed Jan 4 21:37:55 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
351 366
352 $pkg 367 $pkg
353 } 368 }
354} 369}
355 370
371our $retval; # return value for urxvt
372
356# called by the rxvt core 373# called by the rxvt core
357sub invoke { 374sub invoke {
358 local $TERM = shift; 375 local $TERM = shift;
359 my $htype = shift; 376 my $htype = shift;
360 377
361 if ($htype == 0) { # INIT 378 if ($htype == 0) { # INIT
362 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 379 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
363 380
364 for my $ext (split /:/, $TERM->resource ("perl_ext")) { 381 for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {
365 my @files = grep -f $_, map "$_/$ext", @dirs; 382 my @files = grep -f $_, map "$_/$ext", @dirs;
366 383
367 if (@files) { 384 if (@files) {
368 register_package script_package $files[0]; 385 register_package script_package $files[0];
369 } else { 386 } else {
370 warn "perl extension '$ext' not found in perl library search path\n"; 387 warn "perl extension '$ext' not found in perl library search path\n";
371 } 388 }
372 } 389 }
390 }
373 391
392 $retval = undef;
393
394 if (my $cb = $TERM->{_hook}[$htype]) {
395 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
396 if $verbosity >= 10;
397
398 keys %$cb;
399
400 while (my ($pkg, $cb) = each %$cb) {
401 $retval = $cb->(
402 $TERM->{_pkg}{$pkg} ||= do {
403 my $proxy = bless { }, urxvt::term::proxy::;
404 Scalar::Util::weaken ($proxy->{term} = $TERM);
405 $proxy
406 },
407 @_,
408 ) and last;
409 }
410 }
411
374 } elsif ($htype == 1) { # DESTROY 412 if ($htype == 1) { # DESTROY
413 # remove hooks if unused
375 if (my $hook = $TERM->{_hook}) { 414 if (my $hook = $TERM->{_hook}) {
376 for my $htype (0..$#$hook) { 415 for my $htype (0..$#$hook) {
377 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } 416 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
378 or set_should_invoke $htype, 0; 417 or set_should_invoke $htype, 0;
379 } 418 }
380 } 419 }
420
421 # clear package objects
422 %$_ = () for values %{ $TERM->{_pkg} };
423
424 # clear package
425 %$TERM = ();
381 } 426 }
382 427
383 my $cb = $TERM->{_hook}[$htype] 428 $retval
384 or return;
385
386 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
387 if $verbosity >= 10;
388
389 while (my ($pkg, $cb) = each %$cb) {
390 return 1
391 if $cb->(
392 $TERM->{$pkg} ||= do {
393 my $proxy = bless { }, urxvt::term::proxy::;
394 Scalar::Util::weaken ($proxy->{term} = $TERM);
395 $proxy
396 },
397 @_,
398 );
399 }
400
401 0
402} 429}
403 430
404sub urxvt::term::proxy::AUTOLOAD { 431sub urxvt::term::proxy::AUTOLOAD {
405 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 432 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
406 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 433 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
407 434
408 eval qq{ 435 eval qq{
409 sub $urxvt::term::proxy::AUTOLOAD { 436 sub $urxvt::term::proxy::AUTOLOAD {
410 unshift \@_, shift->{term}; 437 my \$proxy = shift;
411 goto &urxvt::term::$1; 438 \$proxy->{term}->$1 (\@_)
412 } 439 }
413 1 440 1
414 } or die "FATAL: unable to compile method forwarder: $@"; 441 } or die "FATAL: unable to compile method forwarder: $@";
415 442
416 goto &$urxvt::term::proxy::AUTOLOAD; 443 goto &$urxvt::term::proxy::AUTOLOAD;
444 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 471 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
445 borderLess color cursorBlink cursorUnderline cutchars delete_key 472 borderLess color cursorBlink cursorUnderline cutchars delete_key
446 display_name embed ext_bwidth fade font geometry hold iconName 473 display_name embed ext_bwidth fade font geometry hold iconName
447 imFont imLocale inputMethod insecure int_bwidth intensityStyles 474 imFont imLocale inputMethod insecure int_bwidth intensityStyles
448 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 475 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
449 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext 476 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
450 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 477 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
451 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 478 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
452 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 479 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
453 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 480 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
454 shade term_name title transparent transparent_all tripleclickwords 481 shade term_name title transparent transparent_all tripleclickwords
460 my ($self, $name) = (shift, shift); 487 my ($self, $name) = (shift, shift);
461 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 488 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
462 goto &urxvt::term::_resource; 489 goto &urxvt::term::_resource;
463} 490}
464 491
492=item $rend = $term->screen_rstyle ([$new_rstyle])
493
494Return and optionally change the current rendition. Text thta is output by
495the temrianl application will use this style.
496
497=item ($row, $col) = $term->screen_cur ([$row, $col])
498
499Return the current coordinates of the text cursor position and optionally
500set it (which is usually bad as applications don't expect that).
501
465=item ($row, $col) = $term->selection_mark ([$row, $col]) 502=item ($row, $col) = $term->selection_mark ([$row, $col])
466 503
467=item ($row, $col) = $term->selection_beg ([$row, $col]) 504=item ($row, $col) = $term->selection_beg ([$row, $col])
468 505
469=item ($row, $col) = $term->selection_end ([$row, $col]) 506=item ($row, $col) = $term->selection_end ([$row, $col])
553 590
554Write the octets given in C<$data> to the tty (i.e. as program input). To 591Write the octets given in C<$data> to the tty (i.e. as program input). To
555pass characters instead of octets, you should convert your strings first 592pass characters instead of octets, you should convert your strings first
556to the locale-specific encoding using C<< $term->locale_encode >>. 593to the locale-specific encoding using C<< $term->locale_encode >>.
557 594
595=item $window_width = $term->width
596
597=item $window_height = $term->height
598
599=item $font_width = $term->fwidth
600
601=item $font_height = $term->fheight
602
603=item $font_ascent = $term->fbase
604
558=item $nrow = $term->nrow 605=item $terminal_rows = $term->nrow
559 606
560=item $ncol = $term->ncol 607=item $terminal_columns = $term->ncol
561 608
562Return the number of rows/columns of the terminal window (i.e. as 609=item $has_focus = $term->focus
563specified by C<-geometry>, excluding any scrollback).
564 610
565=item $nsaved = $term->nsaved 611=item $is_mapped = $term->mapped
566 612
567Returns the number of lines in the scrollback buffer. 613=item $max_scrollback = $term->saveLines
614
615=item $nrow_plus_saveLines = $term->total_rows
616
617=item $lines_in_scrollback = $term->nsaved
618
619Return various integers describing terminal characteristics.
568 620
569=item $view_start = $term->view_start ([$newvalue]) 621=item $view_start = $term->view_start ([$newvalue])
570 622
571Returns the negative row number of the topmost line. Minimum value is 623Returns the negative row number of the topmost line. Minimum value is
572C<0>, which displays the normal terminal contents. Larger values scroll 624C<0>, which displays the normal terminal contents. Larger values scroll
583=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 635=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
584 636
585Returns the text of the entire row with number C<$row_number>. Row C<0> 637Returns 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 638is 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 639terminal line. The scrollback buffer starts at line C<-1> and extends to
588line C<< -$term->nsaved >>. 640line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
641is requested.
589 642
590If C<$new_text> is specified, it will replace characters in the current 643If 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 644line, 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 645to replace only parts of a line. The font index in the rendition will
593automatically be updated. 646automatically be updated.
615 668
616See the section on RENDITION, above. 669See the section on RENDITION, above.
617 670
618=item $length = $term->ROW_l ($row_number[, $new_length]) 671=item $length = $term->ROW_l ($row_number[, $new_length])
619 672
620Returns the number of screen cells that are in use ("the line length"). If 673Returns 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 674length"). 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. 675line is joined with the following one.
623 676
677=item $bool = $term->is_longer ($row_number)
678
679Returns true if the row is part of a multiple-row logical "line" (i.e.
680joined with the following row), which means all characters are in use
681and it is continued on the next row (and possibly a continuation of the
682previous row(s)).
683
684=item $line = $term->line ($row_number)
685
686Create and return a new C<urxvt::line> object that stores information
687about the logical line that row C<$row_number> is part of. It supports the
688following methods:
689
690=over 4
691
692=item $text = $line->t
693
694Returns the full text of the line, similar to C<ROW_t>
695
696=item $rend = $line->r
697
698Returns the full rendition array of the line, similar to C<ROW_r>
699
700=item $length = $line->l
701
702Returns the length of the line in cells, similar to C<ROW_l>.
703
704=item $rownum = $line->beg
705
706=item $rownum = $line->end
707
708Return the row number of the first/last row of the line, respectively.
709
710=item $offset = $line->offset_of ($row, $col)
711
712Returns the character offset of the given row|col pair within the logical
713line.
714
715=item ($row, $col) = $line->coord_of ($offset)
716
717Translates a string offset into terminal coordinates again.
718
719=back
720
721=cut
722
723sub urxvt::term::line {
724 my ($self, $row) = @_;
725
726 my $maxrow = $self->nrow - 1;
727
728 my ($beg, $end) = ($row, $row);
729
730 --$beg while $self->ROW_is_longer ($beg - 1);
731 ++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
732
733 bless {
734 term => $self,
735 beg => $beg,
736 end => $end,
737 len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
738 }, urxvt::line::
739}
740
741sub urxvt::line::t {
742 my ($self) = @_;
743
744 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
745 0, $self->{len}
746}
747
748sub urxvt::line::r {
749 my ($self) = @_;
750
751 my $rend = [
752 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
753 ];
754 $#$rend = $self->{len} - 1;
755 $rend
756}
757
758sub urxvt::line::beg { $_[0]{beg} }
759sub urxvt::line::end { $_[0]{end} }
760sub urxvt::line::l { $_[0]{len} }
761
762sub urxvt::line::offset_of {
763 my ($self, $row, $col) = @_;
764
765 ($row - $self->{beg}) * $self->{term}->ncol + $col
766}
767
768sub urxvt::line::coord_of {
769 my ($self, $offset) = @_;
770
771 use integer;
772
773 (
774 $offset / $self->{term}->ncol + $self->{beg},
775 $offset % $self->{term}->ncol
776 )
777}
778
779=item ($row, $col) = $line->coord_of ($offset)
624=item $text = $term->special_encode $string 780=item $text = $term->special_encode $string
625 781
626Converts a perl string into the special encoding used by rxvt-unicode, 782Converts a perl string into the special encoding used by rxvt-unicode,
627where one character corresponds to one screen cell. See 783where one character corresponds to one screen cell. See
628C<< $term->ROW_t >> for details. 784C<< $term->ROW_t >> for details.
742This variable controls the verbosity level of the perl extension. Higher 898This variable controls the verbosity level of the perl extension. Higher
743numbers indicate more verbose output. 899numbers indicate more verbose output.
744 900
745=over 4 901=over 4
746 902
747=item 0 - only fatal messages 903=item =0 - only fatal messages
748 904
749=item 3 - script loading and management 905=item =3 - script loading and management
750 906
751=item 10 - all events received 907=item =10 - all events received
752 908
753=back 909=back
754 910
755=head1 AUTHOR 911=head1 AUTHOR
756 912

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines