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.27 by root, Tue Jan 3 23:41:37 2006 UTC vs.
Revision 1.36 by root, Fri Jan 6 02:58:02 2006 UTC

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 64
65=item mark-urls
66
67Uses per-line filtering (C<on_line_update>) to underline urls.
68
65=item example-refresh-hooks 69=item example-refresh-hooks
66 70
67Displays a very simple digital clock in the upper right corner of the 71Displays a very simple digital clock in the upper right corner of the
68window. Illustrates overwriting the refresh callbacks to create your own 72window. Illustrates overwriting the refresh callbacks to create your own
69overlays or changes. 73overlays or changes.
74
75=item example-filter-input
76
77A not very useful example of filtering all text output to the terminal, by
78underlining all urls that matches a certain regex (i.e. some urls :). It
79is not very useful because urls that are output in multiple steps (e.g.
80when typing them) do not get marked.
70 81
71=back 82=back
72 83
73=head2 General API Considerations 84=head2 General API Considerations
74 85
81When objects are destroyed on the C++ side, the perl object hashes are 92When 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 93emptied, 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 94the like inside the terminal object so they get destroyed as soon as the
84terminal is destroyed. 95terminal is destroyed.
85 96
97Argument names also often indicate the type of a parameter. Here are some
98hints on what they mean:
99
100=over 4
101
102=item $text
103
104Rxvt-unicodes special way of encoding text, where one "unicode" character
105always represents one screen cell. See L<row_t> for a discussion of this format.
106
107=item $string
108
109A perl text string, with an emphasis on I<text>. It can store all unicode
110characters and is to be distinguished with text encoded in a specific
111encoding (often locale-specific) and binary data.
112
113=item $octets
114
115Either binary data or - more common - a text string encoded in a
116locale-specific way.
117
118=back
119
86=head2 Hooks 120=head2 Hooks
87 121
88The following subroutines can be declared in loaded scripts, and will be 122The following subroutines can be declared in loaded scripts, and will be
89called whenever the relevant event happens. 123called whenever the relevant event happens.
90 124
103=over 4 137=over 4
104 138
105=item on_init $term 139=item on_init $term
106 140
107Called after a new terminal object has been initialized, but before 141Called after a new terminal object has been initialized, but before
108windows are created or the command gets run. 142windows are created or the command gets run. Most methods are unsafe to
143call or deliver senseless data, as terminal size and other characteristics
144have not yet been determined. You can safely query and change resources,
145though.
109 146
110=item on_reset $term 147=item on_reset $term
111 148
112Called after the screen is "reset" for any reason, such as resizing or 149Called 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 150control sequences. Here is where you can react on changes to size-related
172 209
173=item on_tty_activity $term *NYI* 210=item on_tty_activity $term *NYI*
174 211
175Called whenever the program(s) running in the urxvt window send output. 212Called whenever the program(s) running in the urxvt window send output.
176 213
214=item on_osc_seq $term, $string
215
216Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
217operating system command) is processed. Cursor position and other state
218information is up-to-date when this happens. For interoperability, the
219string should start with the extension name and a colon, to distinguish
220it from commands for other extensions, and this might be enforced in the
221future.
222
223Be careful not ever to trust (in a security sense) the data you receive,
224as its source can not easily be controleld (e-mail content, messages from
225other users on the same system etc.).
226
227=item on_add_lines $term, $string
228
229Called whenever text is about to be output, with the text as argument. You
230can filter/change and output the text yourself by returning a true value
231and calling C<< $term->scr_add_lines >> yourself. Please note that this
232might be very slow, however, as your hook is called for B<all> text being
233output.
234
235=item on_line_update $term, $row
236
237Called whenever a line was updated or changed. Can be used to filter
238screen output (e.g. underline urls or other useless stuff). Only lines
239that are being shown will be filtered, and, due to performance reasons,
240not always immediately.
241
242The row number is always the topmost row of the line if the line spans
243multiple rows.
244
245Please note that, if you change the line, then the hook might get called
246later with the already-modified line (e.g. if unrelated parts change), so
247you cannot just toggle rendition bits, but only set them.
248
177=item on_refresh_begin $term 249=item on_refresh_begin $term
178 250
179Called just before the screen gets redrawn. Can be used for overlay 251Called just before the screen gets redrawn. Can be used for overlay
180or similar effects by modify terminal contents in refresh_begin, and 252or similar effects by modify terminal contents in refresh_begin, and
181restoring them in refresh_end. The built-in overlay and selection display 253restoring them in refresh_end. The built-in overlay and selection display
205=back 277=back
206 278
207=head2 Functions in the C<urxvt> Package 279=head2 Functions in the C<urxvt> Package
208 280
209=over 4 281=over 4
282
283=item $term = new urxvt [arg...]
284
285Creates a new terminal, very similar as if you had started it with
286C<system $binfile, arg...>. Croaks (and probably outputs an error message)
287if the new instance couldn't be created. Returns C<undef> if the new
288instance didn't initialise perl, and the terminal object otherwise. The
289C<init> and C<start> hooks will be called during the call.
210 290
211=item urxvt::fatal $errormessage 291=item urxvt::fatal $errormessage
212 292
213Fatally aborts execution with the given error message. Avoid at all 293Fatally aborts execution with the given error message. Avoid at all
214costs! The only time this is acceptable is when the terminal process 294costs! The only time this is acceptable is when the terminal process
353 433
354 $pkg 434 $pkg
355 } 435 }
356} 436}
357 437
438our $retval; # return value for urxvt
439
358# called by the rxvt core 440# called by the rxvt core
359sub invoke { 441sub invoke {
360 local $TERM = shift; 442 local $TERM = shift;
361 my $htype = shift; 443 my $htype = shift;
362 444
363 if ($htype == 0) { # INIT 445 if ($htype == 0) { # INIT
364 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 446 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
365 447
366 for my $ext (split /:/, $TERM->resource ("perl_ext")) { 448 for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {
367 my @files = grep -f $_, map "$_/$ext", @dirs; 449 my @files = grep -f $_, map "$_/$ext", @dirs;
368 450
369 if (@files) { 451 if (@files) {
370 register_package script_package $files[0]; 452 register_package script_package $files[0];
371 } else { 453 } else {
372 warn "perl extension '$ext' not found in perl library search path\n"; 454 warn "perl extension '$ext' not found in perl library search path\n";
373 } 455 }
374 } 456 }
457 }
375 458
459 $retval = undef;
460
461 if (my $cb = $TERM->{_hook}[$htype]) {
462 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
463 if $verbosity >= 10;
464
465 keys %$cb;
466
467 while (my ($pkg, $cb) = each %$cb) {
468 $retval = $cb->(
469 $TERM->{_pkg}{$pkg} ||= do {
470 my $proxy = bless { }, urxvt::term::proxy::;
471 Scalar::Util::weaken ($proxy->{term} = $TERM);
472 $proxy
473 },
474 @_,
475 ) and last;
476 }
477 }
478
376 } elsif ($htype == 1) { # DESTROY 479 if ($htype == 1) { # DESTROY
480 # remove hooks if unused
377 if (my $hook = $TERM->{_hook}) { 481 if (my $hook = $TERM->{_hook}) {
378 for my $htype (0..$#$hook) { 482 for my $htype (0..$#$hook) {
379 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } 483 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
380 or set_should_invoke $htype, 0; 484 or set_should_invoke $htype, 0;
381 } 485 }
382 } 486 }
487
488 # clear package objects
489 %$_ = () for values %{ $TERM->{_pkg} };
490
491 # clear package
492 %$TERM = ();
383 } 493 }
384 494
385 my $cb = $TERM->{_hook}[$htype] 495 $retval
386 or return;
387
388 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
389 if $verbosity >= 10;
390
391 keys %$cb;
392
393 while (my ($pkg, $cb) = each %$cb) {
394 return 1
395 if $cb->(
396 $TERM->{$pkg} ||= do {
397 my $proxy = bless { }, urxvt::term::proxy::;
398 Scalar::Util::weaken ($proxy->{term} = $TERM);
399 $proxy
400 },
401 @_,
402 );
403 }
404
405 0
406} 496}
407 497
408sub urxvt::term::proxy::AUTOLOAD { 498sub urxvt::term::proxy::AUTOLOAD {
409 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 499 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
410 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 500 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
422 512
423=head2 The C<urxvt::term> Class 513=head2 The C<urxvt::term> Class
424 514
425=over 4 515=over 4
426 516
517=item $term->destroy
518
519Destroy the terminal object (close the window, free resources etc.).
520
427=item $value = $term->resource ($name[, $newval]) 521=item $value = $term->resource ($name[, $newval])
428 522
429Returns the current resource value associated with a given name and 523Returns the current resource value associated with a given name and
430optionally sets a new value. Setting values is most useful in the C<init> 524optionally sets a new value. Setting values is most useful in the C<init>
431hook. Unset resources are returned and accepted as C<undef>. 525hook. Unset resources are returned and accepted as C<undef>.
448 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 542 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
449 borderLess color cursorBlink cursorUnderline cutchars delete_key 543 borderLess color cursorBlink cursorUnderline cutchars delete_key
450 display_name embed ext_bwidth fade font geometry hold iconName 544 display_name embed ext_bwidth fade font geometry hold iconName
451 imFont imLocale inputMethod insecure int_bwidth intensityStyles 545 imFont imLocale inputMethod insecure int_bwidth intensityStyles
452 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 546 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
453 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext 547 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
454 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 548 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
455 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 549 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
456 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 550 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
457 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 551 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
458 shade term_name title transparent transparent_all tripleclickwords 552 shade term_name title transparent transparent_all tripleclickwords
464 my ($self, $name) = (shift, shift); 558 my ($self, $name) = (shift, shift);
465 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 559 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
466 goto &urxvt::term::_resource; 560 goto &urxvt::term::_resource;
467} 561}
468 562
563=item $rend = $term->rstyle ([$new_rstyle])
564
565Return and optionally change the current rendition. Text that is output by
566the terminal application will use this style.
567
568=item ($row, $col) = $term->screen_cur ([$row, $col])
569
570Return the current coordinates of the text cursor position and optionally
571set it (which is usually bad as applications don't expect that).
572
469=item ($row, $col) = $term->selection_mark ([$row, $col]) 573=item ($row, $col) = $term->selection_mark ([$row, $col])
470 574
471=item ($row, $col) = $term->selection_beg ([$row, $col]) 575=item ($row, $col) = $term->selection_beg ([$row, $col])
472 576
473=item ($row, $col) = $term->selection_end ([$row, $col]) 577=item ($row, $col) = $term->selection_end ([$row, $col])
487#=item $term->overlay ($x, $y, $text) 591#=item $term->overlay ($x, $y, $text)
488# 592#
489#Create a simple multi-line overlay box. See the next method for details. 593#Create a simple multi-line overlay box. See the next method for details.
490# 594#
491#=cut 595#=cut
492 596#
493sub urxvt::term::scr_overlay { 597#sub urxvt::term::scr_overlay {
494die;
495 my ($self, $x, $y, $text) = @_; 598# my ($self, $x, $y, $text) = @_;
496 599#
497 my @lines = split /\n/, $text; 600# my @lines = split /\n/, $text;
498 601#
499 my $w = 0; 602# my $w = 0;
500 for (map $self->strwidth ($_), @lines) { 603# for (map $self->strwidth ($_), @lines) {
501 $w = $_ if $w < $_; 604# $w = $_ if $w < $_;
502 } 605# }
503 606#
504 $self->scr_overlay_new ($x, $y, $w, scalar @lines); 607# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
505 $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; 608# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
506} 609#}
507 610
508=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) 611=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
509 612
510Create a new (empty) overlay at the given position with the given 613Create a new (empty) overlay at the given position with the given
511width/height. C<$rstyle> defines the initial rendition style 614width/height. C<$rstyle> defines the initial rendition style
551 654
552=item $string = $term->locale_decode $octets 655=item $string = $term->locale_decode $octets
553 656
554Convert the given locale-encoded octets into a perl string. 657Convert the given locale-encoded octets into a perl string.
555 658
659=item $term->scr_add_lines ($string)
660
661Write the given text string to the screen, as if output by the application
662running inside the terminal. It may not contain command sequences (escape
663codes), but is free to use line feeds, carriage returns and tabs. The
664string is a normal text string, not in locale-dependent encoding.
665
666Normally its not a good idea to use this function, as programs might be
667confused by changes in cursor position or scrolling. Its useful inside a
668C<on_add_lines> hook, though.
669
670=item $term->cmd_parse ($octets)
671
672Similar to C<scr_add_lines>, but the argument must be in the
673locale-specific encoding of the terminal and can contain command sequences
674(escape codes) that will be interpreted.
675
556=item $term->tt_write ($octets) 676=item $term->tt_write ($octets)
557 677
558Write the octets given in C<$data> to the tty (i.e. as program input). To 678Write the octets given in C<$data> to the tty (i.e. as program input). To
559pass characters instead of octets, you should convert your strings first 679pass characters instead of octets, you should convert your strings first
560to the locale-specific encoding using C<< $term->locale_encode >>. 680to the locale-specific encoding using C<< $term->locale_encode >>.
561 681
682=item $window_width = $term->width
683
684=item $window_height = $term->height
685
686=item $font_width = $term->fwidth
687
688=item $font_height = $term->fheight
689
690=item $font_ascent = $term->fbase
691
562=item $nrow = $term->nrow 692=item $terminal_rows = $term->nrow
563 693
564=item $ncol = $term->ncol 694=item $terminal_columns = $term->ncol
565 695
566Return the number of rows/columns of the terminal window (i.e. as 696=item $has_focus = $term->focus
567specified by C<-geometry>, excluding any scrollback).
568 697
569=item $nsaved = $term->nsaved 698=item $is_mapped = $term->mapped
570 699
571Returns the number of lines in the scrollback buffer. 700=item $max_scrollback = $term->saveLines
701
702=item $nrow_plus_saveLines = $term->total_rows
703
704=item $lines_in_scrollback = $term->nsaved
705
706Return various integers describing terminal characteristics.
572 707
573=item $view_start = $term->view_start ([$newvalue]) 708=item $view_start = $term->view_start ([$newvalue])
574 709
575Returns the negative row number of the topmost line. Minimum value is 710Returns the negative row number of the topmost line. Minimum value is
576C<0>, which displays the normal terminal contents. Larger values scroll 711C<0>, which displays the normal terminal contents. Larger values scroll
639about the logical line that row C<$row_number> is part of. It supports the 774about the logical line that row C<$row_number> is part of. It supports the
640following methods: 775following methods:
641 776
642=over 4 777=over 4
643 778
644=item $text = $line->t 779=item $text = $line->t ([$new_text])
645 780
646Returns the full text of the line, similar to C<ROW_t> 781Returns or replaces the full text of the line, similar to C<ROW_t>
647 782
648=item $rend = $line->r 783=item $rend = $line->r ([$new_rend])
649 784
650Returns the full rendition array of the line, similar to C<ROW_r> 785Returns or replaces the full rendition array of the line, similar to C<ROW_r>
651 786
652=item $length = $line->l 787=item $length = $line->l
653 788
654Returns the length of the line in cells, similar to C<ROW_l>. 789Returns the length of the line in cells, similar to C<ROW_l>.
655 790
684 819
685 bless { 820 bless {
686 term => $self, 821 term => $self,
687 beg => $beg, 822 beg => $beg,
688 end => $end, 823 end => $end,
824 ncol => $self->ncol,
689 len => ($end - $beg) * $self->ncol + $self->ROW_l ($end), 825 len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
690 }, urxvt::line:: 826 }, urxvt::line::
691} 827}
692 828
693sub urxvt::line::t { 829sub urxvt::line::t {
694 my ($self) = @_; 830 my ($self) = @_;
695 831
832 if (@_ > 1)
833 {
834 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
835 for $self->{beg} .. $self->{end};
836 }
837
838 defined wantarray &&
696 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), 839 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
697 0, $self->{len} 840 0, $self->{len}
698} 841}
699 842
700sub urxvt::line::r { 843sub urxvt::line::r {
701 my ($self) = @_; 844 my ($self) = @_;
702 845
846 if (@_ > 1)
847 {
848 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
849 for $self->{beg} .. $self->{end};
850 }
851
852 if (defined wantarray) {
703 my $rend = [ 853 my $rend = [
704 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} 854 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
705 ]; 855 ];
706 $#$rend = $self->{len} - 1; 856 $#$rend = $self->{len} - 1;
707 $rend 857 return $rend;
858 }
859
860 ()
708} 861}
709 862
710sub urxvt::line::beg { $_[0]{beg} } 863sub urxvt::line::beg { $_[0]{beg} }
711sub urxvt::line::end { $_[0]{end} } 864sub urxvt::line::end { $_[0]{end} }
712sub urxvt::line::l { $_[0]{len} } 865sub urxvt::line::l { $_[0]{len} }
713 866
714sub urxvt::line::offset_of { 867sub urxvt::line::offset_of {
715 my ($self, $row, $col) = @_; 868 my ($self, $row, $col) = @_;
716 869
717 ($row - $self->{beg}) * $self->{term}->ncol + $col 870 ($row - $self->{beg}) * $self->{ncol} + $col
718} 871}
719 872
720sub urxvt::line::coord_of { 873sub urxvt::line::coord_of {
721 my ($self, $offset) = @_; 874 my ($self, $offset) = @_;
722 875
723 use integer; 876 use integer;
724 877
725 ( 878 (
726 $offset / $self->{term}->ncol + $self->{beg}, 879 $offset / $self->{ncol} + $self->{beg},
727 $offset % $self->{term}->ncol 880 $offset % $self->{ncol}
728 ) 881 )
729} 882}
730 883
731=item ($row, $col) = $line->coord_of ($offset) 884=item ($row, $col) = $line->coord_of ($offset)
732=item $text = $term->special_encode $string 885=item $text = $term->special_encode $string

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines