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.30 by root, Wed Jan 4 05:35:34 2006 UTC vs.
Revision 1.37 by root, Fri Jan 6 03:40:19 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
185 222
186Be careful not ever to trust (in a security sense) the data you receive, 223Be 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 224as its source can not easily be controleld (e-mail content, messages from
188other users on the same system etc.). 225other users on the same system etc.).
189 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
190=item on_refresh_begin $term 249=item on_refresh_begin $term
191 250
192Called just before the screen gets redrawn. Can be used for overlay 251Called just before the screen gets redrawn. Can be used for overlay
193or similar effects by modify terminal contents in refresh_begin, and 252or similar effects by modify terminal contents in refresh_begin, and
194restoring them in refresh_end. The built-in overlay and selection display 253restoring them in refresh_end. The built-in overlay and selection display
202 261
203Called whenever the user presses a key combination that has a 262Called whenever the user presses a key combination that has a
204C<perl:string> action bound to it (see description of the B<keysym> 263C<perl:string> action bound to it (see description of the B<keysym>
205resource in the @@RXVT_NAME@@(1) manpage). 264resource in the @@RXVT_NAME@@(1) manpage).
206 265
266=item on_key_press $term, $event
267
268=item on_key_release $term, $event
269
270=item on_button_press $term, $event
271
272=item on_button_release $term, $event
273
274=item on_motion_notify $term, $event
275
276Called whenever the corresponding X event is received for the terminal. If
277the hook returns true, then the even will be ignored by rxvt-unicode.
278
279subwindow.
280
207=back 281=back
208 282
209=head2 Variables in the C<urxvt> Package 283=head2 Variables in the C<urxvt> Package
210 284
211=over 4 285=over 4
218=back 292=back
219 293
220=head2 Functions in the C<urxvt> Package 294=head2 Functions in the C<urxvt> Package
221 295
222=over 4 296=over 4
297
298=item $term = new urxvt [arg...]
299
300Creates a new terminal, very similar as if you had started it with
301C<system $binfile, arg...>. Croaks (and probably outputs an error message)
302if the new instance couldn't be created. Returns C<undef> if the new
303instance didn't initialise perl, and the terminal object otherwise. The
304C<init> and C<start> hooks will be called during the call.
223 305
224=item urxvt::fatal $errormessage 306=item urxvt::fatal $errormessage
225 307
226Fatally aborts execution with the given error message. Avoid at all 308Fatally aborts execution with the given error message. Avoid at all
227costs! The only time this is acceptable is when the terminal process 309costs! The only time this is acceptable is when the terminal process
366 448
367 $pkg 449 $pkg
368 } 450 }
369} 451}
370 452
453our $retval; # return value for urxvt
454
371# called by the rxvt core 455# called by the rxvt core
372sub invoke { 456sub invoke {
373 local $TERM = shift; 457 local $TERM = shift;
374 my $htype = shift; 458 my $htype = shift;
375 459
383 register_package script_package $files[0]; 467 register_package script_package $files[0];
384 } else { 468 } else {
385 warn "perl extension '$ext' not found in perl library search path\n"; 469 warn "perl extension '$ext' not found in perl library search path\n";
386 } 470 }
387 } 471 }
472 }
388 473
474 $retval = undef;
475
476 if (my $cb = $TERM->{_hook}[$htype]) {
477 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
478 if $verbosity >= 10;
479
480 keys %$cb;
481
482 while (my ($pkg, $cb) = each %$cb) {
483 $retval = $cb->(
484 $TERM->{_pkg}{$pkg} ||= do {
485 my $proxy = bless { }, urxvt::term::proxy::;
486 Scalar::Util::weaken ($proxy->{term} = $TERM);
487 $proxy
488 },
489 @_,
490 ) and last;
491 }
492 }
493
389 } elsif ($htype == 1) { # DESTROY 494 if ($htype == 1) { # DESTROY
495 # remove hooks if unused
390 if (my $hook = $TERM->{_hook}) { 496 if (my $hook = $TERM->{_hook}) {
391 for my $htype (0..$#$hook) { 497 for my $htype (0..$#$hook) {
392 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } 498 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
393 or set_should_invoke $htype, 0; 499 or set_should_invoke $htype, 0;
394 } 500 }
395 } 501 }
502
503 # clear package objects
504 %$_ = () for values %{ $TERM->{_pkg} };
505
506 # clear package
507 %$TERM = ();
396 } 508 }
397 509
398 my $cb = $TERM->{_hook}[$htype] 510 $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} 511}
420 512
421sub urxvt::term::proxy::AUTOLOAD { 513sub urxvt::term::proxy::AUTOLOAD {
422 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 514 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
423 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 515 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
434} 526}
435 527
436=head2 The C<urxvt::term> Class 528=head2 The C<urxvt::term> Class
437 529
438=over 4 530=over 4
531
532=item $term->destroy
533
534Destroy the terminal object (close the window, free resources etc.).
439 535
440=item $value = $term->resource ($name[, $newval]) 536=item $value = $term->resource ($name[, $newval])
441 537
442Returns the current resource value associated with a given name and 538Returns the current resource value associated with a given name and
443optionally sets a new value. Setting values is most useful in the C<init> 539optionally sets a new value. Setting values is most useful in the C<init>
477 my ($self, $name) = (shift, shift); 573 my ($self, $name) = (shift, shift);
478 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 574 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
479 goto &urxvt::term::_resource; 575 goto &urxvt::term::_resource;
480} 576}
481 577
578=item $rend = $term->rstyle ([$new_rstyle])
579
580Return and optionally change the current rendition. Text that is output by
581the terminal application will use this style.
582
583=item ($row, $col) = $term->screen_cur ([$row, $col])
584
585Return the current coordinates of the text cursor position and optionally
586set it (which is usually bad as applications don't expect that).
587
482=item ($row, $col) = $term->selection_mark ([$row, $col]) 588=item ($row, $col) = $term->selection_mark ([$row, $col])
483 589
484=item ($row, $col) = $term->selection_beg ([$row, $col]) 590=item ($row, $col) = $term->selection_beg ([$row, $col])
485 591
486=item ($row, $col) = $term->selection_end ([$row, $col]) 592=item ($row, $col) = $term->selection_end ([$row, $col])
500#=item $term->overlay ($x, $y, $text) 606#=item $term->overlay ($x, $y, $text)
501# 607#
502#Create a simple multi-line overlay box. See the next method for details. 608#Create a simple multi-line overlay box. See the next method for details.
503# 609#
504#=cut 610#=cut
505 611#
506sub urxvt::term::scr_overlay { 612#sub urxvt::term::scr_overlay {
507die;
508 my ($self, $x, $y, $text) = @_; 613# my ($self, $x, $y, $text) = @_;
509 614#
510 my @lines = split /\n/, $text; 615# my @lines = split /\n/, $text;
511 616#
512 my $w = 0; 617# my $w = 0;
513 for (map $self->strwidth ($_), @lines) { 618# for (map $self->strwidth ($_), @lines) {
514 $w = $_ if $w < $_; 619# $w = $_ if $w < $_;
515 } 620# }
516 621#
517 $self->scr_overlay_new ($x, $y, $w, scalar @lines); 622# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
518 $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; 623# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
519} 624#}
520 625
521=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) 626=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
522 627
523Create a new (empty) overlay at the given position with the given 628Create a new (empty) overlay at the given position with the given
524width/height. C<$rstyle> defines the initial rendition style 629width/height. C<$rstyle> defines the initial rendition style
564 669
565=item $string = $term->locale_decode $octets 670=item $string = $term->locale_decode $octets
566 671
567Convert the given locale-encoded octets into a perl string. 672Convert the given locale-encoded octets into a perl string.
568 673
674=item $term->scr_add_lines ($string)
675
676Write the given text string to the screen, as if output by the application
677running inside the terminal. It may not contain command sequences (escape
678codes), but is free to use line feeds, carriage returns and tabs. The
679string is a normal text string, not in locale-dependent encoding.
680
681Normally its not a good idea to use this function, as programs might be
682confused by changes in cursor position or scrolling. Its useful inside a
683C<on_add_lines> hook, though.
684
685=item $term->cmd_parse ($octets)
686
687Similar to C<scr_add_lines>, but the argument must be in the
688locale-specific encoding of the terminal and can contain command sequences
689(escape codes) that will be interpreted.
690
569=item $term->tt_write ($octets) 691=item $term->tt_write ($octets)
570 692
571Write the octets given in C<$data> to the tty (i.e. as program input). To 693Write 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 694pass characters instead of octets, you should convert your strings first
573to the locale-specific encoding using C<< $term->locale_encode >>. 695to the locale-specific encoding using C<< $term->locale_encode >>.
574 696
697=item $window_width = $term->width
698
699=item $window_height = $term->height
700
701=item $font_width = $term->fwidth
702
703=item $font_height = $term->fheight
704
705=item $font_ascent = $term->fbase
706
575=item $nrow = $term->nrow 707=item $terminal_rows = $term->nrow
576 708
577=item $ncol = $term->ncol 709=item $terminal_columns = $term->ncol
578 710
579Return the number of rows/columns of the terminal window (i.e. as 711=item $has_focus = $term->focus
580specified by C<-geometry>, excluding any scrollback).
581 712
582=item $nsaved = $term->nsaved 713=item $is_mapped = $term->mapped
583 714
584Returns the number of lines in the scrollback buffer. 715=item $max_scrollback = $term->saveLines
716
717=item $nrow_plus_saveLines = $term->total_rows
718
719=item $lines_in_scrollback = $term->nsaved
720
721Return various integers describing terminal characteristics.
585 722
586=item $view_start = $term->view_start ([$newvalue]) 723=item $view_start = $term->view_start ([$newvalue])
587 724
588Returns the negative row number of the topmost line. Minimum value is 725Returns the negative row number of the topmost line. Minimum value is
589C<0>, which displays the normal terminal contents. Larger values scroll 726C<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 789about the logical line that row C<$row_number> is part of. It supports the
653following methods: 790following methods:
654 791
655=over 4 792=over 4
656 793
657=item $text = $line->t 794=item $text = $line->t ([$new_text])
658 795
659Returns the full text of the line, similar to C<ROW_t> 796Returns or replaces the full text of the line, similar to C<ROW_t>
660 797
661=item $rend = $line->r 798=item $rend = $line->r ([$new_rend])
662 799
663Returns the full rendition array of the line, similar to C<ROW_r> 800Returns or replaces the full rendition array of the line, similar to C<ROW_r>
664 801
665=item $length = $line->l 802=item $length = $line->l
666 803
667Returns the length of the line in cells, similar to C<ROW_l>. 804Returns the length of the line in cells, similar to C<ROW_l>.
668 805
697 834
698 bless { 835 bless {
699 term => $self, 836 term => $self,
700 beg => $beg, 837 beg => $beg,
701 end => $end, 838 end => $end,
839 ncol => $self->ncol,
702 len => ($end - $beg) * $self->ncol + $self->ROW_l ($end), 840 len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
703 }, urxvt::line:: 841 }, urxvt::line::
704} 842}
705 843
706sub urxvt::line::t { 844sub urxvt::line::t {
707 my ($self) = @_; 845 my ($self) = @_;
708 846
847 if (@_ > 1)
848 {
849 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
850 for $self->{beg} .. $self->{end};
851 }
852
853 defined wantarray &&
709 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), 854 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
710 0, $self->{len} 855 0, $self->{len}
711} 856}
712 857
713sub urxvt::line::r { 858sub urxvt::line::r {
714 my ($self) = @_; 859 my ($self) = @_;
715 860
861 if (@_ > 1)
862 {
863 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
864 for $self->{beg} .. $self->{end};
865 }
866
867 if (defined wantarray) {
716 my $rend = [ 868 my $rend = [
717 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} 869 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
718 ]; 870 ];
719 $#$rend = $self->{len} - 1; 871 $#$rend = $self->{len} - 1;
720 $rend 872 return $rend;
873 }
874
875 ()
721} 876}
722 877
723sub urxvt::line::beg { $_[0]{beg} } 878sub urxvt::line::beg { $_[0]{beg} }
724sub urxvt::line::end { $_[0]{end} } 879sub urxvt::line::end { $_[0]{end} }
725sub urxvt::line::l { $_[0]{len} } 880sub urxvt::line::l { $_[0]{len} }
726 881
727sub urxvt::line::offset_of { 882sub urxvt::line::offset_of {
728 my ($self, $row, $col) = @_; 883 my ($self, $row, $col) = @_;
729 884
730 ($row - $self->{beg}) * $self->{term}->ncol + $col 885 ($row - $self->{beg}) * $self->{ncol} + $col
731} 886}
732 887
733sub urxvt::line::coord_of { 888sub urxvt::line::coord_of {
734 my ($self, $offset) = @_; 889 my ($self, $offset) = @_;
735 890
736 use integer; 891 use integer;
737 892
738 ( 893 (
739 $offset / $self->{term}->ncol + $self->{beg}, 894 $offset / $self->{ncol} + $self->{beg},
740 $offset % $self->{term}->ncol 895 $offset % $self->{ncol}
741 ) 896 )
742} 897}
743 898
744=item ($row, $col) = $line->coord_of ($offset) 899=item ($row, $col) = $line->coord_of ($offset)
745=item $text = $term->special_encode $string 900=item $text = $term->special_encode $string

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines