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.26 by root, Tue Jan 3 21:22:22 2006 UTC vs.
Revision 1.39 by root, Fri Jan 6 05:28:55 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
189 261
190Called whenever the user presses a key combination that has a 262Called whenever the user presses a key combination that has a
191C<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>
192resource in the @@RXVT_NAME@@(1) manpage). 264resource in the @@RXVT_NAME@@(1) manpage).
193 265
266=item on_key_press $term, $event, $octets
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
279The event is a hash with most values as named by Xlib (see the XEvent
280manpage), with the additional members C<row> and C<col>, which are the row
281and column under the mouse cursor.
282
283C<on_key_press> additionally receives the string rxvt-unicode would
284output, if any, in locale-specific encoding.
285
286subwindow.
287
194=back 288=back
195 289
196=head2 Variables in the C<urxvt> Package 290=head2 Variables in the C<urxvt> Package
197 291
198=over 4 292=over 4
205=back 299=back
206 300
207=head2 Functions in the C<urxvt> Package 301=head2 Functions in the C<urxvt> Package
208 302
209=over 4 303=over 4
304
305=item $term = new urxvt [arg...]
306
307Creates a new terminal, very similar as if you had started it with
308C<system $binfile, arg...>. Croaks (and probably outputs an error message)
309if the new instance couldn't be created. Returns C<undef> if the new
310instance didn't initialise perl, and the terminal object otherwise. The
311C<init> and C<start> hooks will be called during the call.
210 312
211=item urxvt::fatal $errormessage 313=item urxvt::fatal $errormessage
212 314
213Fatally aborts execution with the given error message. Avoid at all 315Fatally aborts execution with the given error message. Avoid at all
214costs! The only time this is acceptable is when the terminal process 316costs! The only time this is acceptable is when the terminal process
353 455
354 $pkg 456 $pkg
355 } 457 }
356} 458}
357 459
460our $retval; # return value for urxvt
461
358# called by the rxvt core 462# called by the rxvt core
359sub invoke { 463sub invoke {
360 local $TERM = shift; 464 local $TERM = shift;
361 my $htype = shift; 465 my $htype = shift;
362 466
363 if ($htype == 0) { # INIT 467 if ($htype == 0) { # INIT
364 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 468 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
365 469
366 for my $ext (split /:/, $TERM->resource ("perl_ext")) { 470 for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {
367 my @files = grep -f $_, map "$_/$ext", @dirs; 471 my @files = grep -f $_, map "$_/$ext", @dirs;
368 472
369 if (@files) { 473 if (@files) {
370 register_package script_package $files[0]; 474 register_package script_package $files[0];
371 } else { 475 } else {
372 warn "perl extension '$ext' not found in perl library search path\n"; 476 warn "perl extension '$ext' not found in perl library search path\n";
373 } 477 }
374 } 478 }
479 }
375 480
481 $retval = undef;
482
483 if (my $cb = $TERM->{_hook}[$htype]) {
484 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
485 if $verbosity >= 10;
486
487 keys %$cb;
488
489 while (my ($pkg, $cb) = each %$cb) {
490 $retval = $cb->(
491 $TERM->{_pkg}{$pkg} ||= do {
492 my $proxy = bless { }, urxvt::term::proxy::;
493 Scalar::Util::weaken ($proxy->{term} = $TERM);
494 $proxy
495 },
496 @_,
497 ) and last;
498 }
499 }
500
376 } elsif ($htype == 1) { # DESTROY 501 if ($htype == 1) { # DESTROY
502 # remove hooks if unused
377 if (my $hook = $TERM->{_hook}) { 503 if (my $hook = $TERM->{_hook}) {
378 for my $htype (0..$#$hook) { 504 for my $htype (0..$#$hook) {
379 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } 505 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
380 or set_should_invoke $htype, 0; 506 or set_should_invoke $htype, 0;
381 } 507 }
382 } 508 }
509
510 # clear package objects
511 %$_ = () for values %{ $TERM->{_pkg} };
512
513 # clear package
514 %$TERM = ();
383 } 515 }
384 516
385 my $cb = $TERM->{_hook}[$htype] 517 $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} 518}
407 519
408sub urxvt::term::proxy::AUTOLOAD { 520sub urxvt::term::proxy::AUTOLOAD {
409 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 521 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
410 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 522 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
422 534
423=head2 The C<urxvt::term> Class 535=head2 The C<urxvt::term> Class
424 536
425=over 4 537=over 4
426 538
539=item $term->destroy
540
541Destroy the terminal object (close the window, free resources etc.).
542
427=item $value = $term->resource ($name[, $newval]) 543=item $value = $term->resource ($name[, $newval])
428 544
429Returns the current resource value associated with a given name and 545Returns the current resource value associated with a given name and
430optionally sets a new value. Setting values is most useful in the C<init> 546optionally sets a new value. Setting values is most useful in the C<init>
431hook. Unset resources are returned and accepted as C<undef>. 547hook. Unset resources are returned and accepted as C<undef>.
448 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 564 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
449 borderLess color cursorBlink cursorUnderline cutchars delete_key 565 borderLess color cursorBlink cursorUnderline cutchars delete_key
450 display_name embed ext_bwidth fade font geometry hold iconName 566 display_name embed ext_bwidth fade font geometry hold iconName
451 imFont imLocale inputMethod insecure int_bwidth intensityStyles 567 imFont imLocale inputMethod insecure int_bwidth intensityStyles
452 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 568 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
453 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext 569 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
454 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 570 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
455 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 571 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
456 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 572 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
457 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 573 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
458 shade term_name title transparent transparent_all tripleclickwords 574 shade term_name title transparent transparent_all tripleclickwords
464 my ($self, $name) = (shift, shift); 580 my ($self, $name) = (shift, shift);
465 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 581 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
466 goto &urxvt::term::_resource; 582 goto &urxvt::term::_resource;
467} 583}
468 584
585=item $rend = $term->rstyle ([$new_rstyle])
586
587Return and optionally change the current rendition. Text that is output by
588the terminal application will use this style.
589
590=item ($row, $col) = $term->screen_cur ([$row, $col])
591
592Return the current coordinates of the text cursor position and optionally
593set it (which is usually bad as applications don't expect that).
594
469=item ($row, $col) = $term->selection_mark ([$row, $col]) 595=item ($row, $col) = $term->selection_mark ([$row, $col])
470 596
471=item ($row, $col) = $term->selection_beg ([$row, $col]) 597=item ($row, $col) = $term->selection_beg ([$row, $col])
472 598
473=item ($row, $col) = $term->selection_end ([$row, $col]) 599=item ($row, $col) = $term->selection_end ([$row, $col])
487#=item $term->overlay ($x, $y, $text) 613#=item $term->overlay ($x, $y, $text)
488# 614#
489#Create a simple multi-line overlay box. See the next method for details. 615#Create a simple multi-line overlay box. See the next method for details.
490# 616#
491#=cut 617#=cut
492 618#
493sub urxvt::term::scr_overlay { 619#sub urxvt::term::scr_overlay {
494die;
495 my ($self, $x, $y, $text) = @_; 620# my ($self, $x, $y, $text) = @_;
496 621#
497 my @lines = split /\n/, $text; 622# my @lines = split /\n/, $text;
498 623#
499 my $w = 0; 624# my $w = 0;
500 for (map $self->strwidth ($_), @lines) { 625# for (map $self->strwidth ($_), @lines) {
501 $w = $_ if $w < $_; 626# $w = $_ if $w < $_;
502 } 627# }
503 628#
504 $self->scr_overlay_new ($x, $y, $w, scalar @lines); 629# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
505 $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; 630# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
506} 631#}
507 632
508=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) 633=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
509 634
510Create a new (empty) overlay at the given position with the given 635Create a new (empty) overlay at the given position with the given
511width/height. C<$rstyle> defines the initial rendition style 636width/height. C<$rstyle> defines the initial rendition style
551 676
552=item $string = $term->locale_decode $octets 677=item $string = $term->locale_decode $octets
553 678
554Convert the given locale-encoded octets into a perl string. 679Convert the given locale-encoded octets into a perl string.
555 680
681=item $term->scr_add_lines ($string)
682
683Write the given text string to the screen, as if output by the application
684running inside the terminal. It may not contain command sequences (escape
685codes), but is free to use line feeds, carriage returns and tabs. The
686string is a normal text string, not in locale-dependent encoding.
687
688Normally its not a good idea to use this function, as programs might be
689confused by changes in cursor position or scrolling. Its useful inside a
690C<on_add_lines> hook, though.
691
692=item $term->cmd_parse ($octets)
693
694Similar to C<scr_add_lines>, but the argument must be in the
695locale-specific encoding of the terminal and can contain command sequences
696(escape codes) that will be interpreted.
697
556=item $term->tt_write ($octets) 698=item $term->tt_write ($octets)
557 699
558Write the octets given in C<$data> to the tty (i.e. as program input). To 700Write 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 701pass characters instead of octets, you should convert your strings first
560to the locale-specific encoding using C<< $term->locale_encode >>. 702to the locale-specific encoding using C<< $term->locale_encode >>.
561 703
704=item $window_width = $term->width
705
706=item $window_height = $term->height
707
708=item $font_width = $term->fwidth
709
710=item $font_height = $term->fheight
711
712=item $font_ascent = $term->fbase
713
562=item $nrow = $term->nrow 714=item $terminal_rows = $term->nrow
563 715
564=item $ncol = $term->ncol 716=item $terminal_columns = $term->ncol
565 717
566Return the number of rows/columns of the terminal window (i.e. as 718=item $has_focus = $term->focus
567specified by C<-geometry>, excluding any scrollback).
568 719
569=item $nsaved = $term->nsaved 720=item $is_mapped = $term->mapped
570 721
571Returns the number of lines in the scrollback buffer. 722=item $max_scrollback = $term->saveLines
723
724=item $nrow_plus_saveLines = $term->total_rows
725
726=item $lines_in_scrollback = $term->nsaved
727
728Return various integers describing terminal characteristics.
572 729
573=item $view_start = $term->view_start ([$newvalue]) 730=item $view_start = $term->view_start ([$newvalue])
574 731
575Returns the negative row number of the topmost line. Minimum value is 732Returns the negative row number of the topmost line. Minimum value is
576C<0>, which displays the normal terminal contents. Larger values scroll 733C<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 796about the logical line that row C<$row_number> is part of. It supports the
640following methods: 797following methods:
641 798
642=over 4 799=over 4
643 800
644=item $text = $line->t 801=item $text = $line->t ([$new_text])
645 802
646Returns the full text of the line, similar to C<ROW_t> 803Returns or replaces the full text of the line, similar to C<ROW_t>
647 804
648=item $rend = $line->r 805=item $rend = $line->r ([$new_rend])
649 806
650Returns the full rendition array of the line, similar to C<ROW_r> 807Returns or replaces the full rendition array of the line, similar to C<ROW_r>
651 808
652=item $length = $line->l 809=item $length = $line->l
653 810
654Returns the length of the line in cells, similar to C<ROW_l>. 811Returns the length of the line in cells, similar to C<ROW_l>.
655 812
684 841
685 bless { 842 bless {
686 term => $self, 843 term => $self,
687 beg => $beg, 844 beg => $beg,
688 end => $end, 845 end => $end,
846 ncol => $self->ncol,
689 len => ($end - $beg) * $self->ncol + $self->ROW_l ($end), 847 len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
690 }, urxvt::line:: 848 }, urxvt::line::
691} 849}
692 850
693sub urxvt::line::t { 851sub urxvt::line::t {
694 my ($self) = @_; 852 my ($self) = @_;
695 853
854 if (@_ > 1)
855 {
856 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
857 for $self->{beg} .. $self->{end};
858 }
859
860 defined wantarray &&
696 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), 861 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
697 0, $self->{len} 862 0, $self->{len}
698} 863}
699 864
700sub urxvt::line::r { 865sub urxvt::line::r {
701 my ($self) = @_; 866 my ($self) = @_;
702 867
868 if (@_ > 1)
869 {
870 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
871 for $self->{beg} .. $self->{end};
872 }
873
874 if (defined wantarray) {
703 my $rend = [ 875 my $rend = [
704 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} 876 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
705 ]; 877 ];
706 $#$rend = $self->{len} - 1; 878 $#$rend = $self->{len} - 1;
707 $rend 879 return $rend;
880 }
881
882 ()
708} 883}
709 884
710sub urxvt::line::beg { $_[0]{beg} } 885sub urxvt::line::beg { $_[0]{beg} }
711sub urxvt::line::end { $_[0]{end} } 886sub urxvt::line::end { $_[0]{end} }
712sub urxvt::line::l { $_[0]{len} } 887sub urxvt::line::l { $_[0]{len} }
713 888
714sub urxvt::line::offset_of { 889sub urxvt::line::offset_of {
715 my ($self, $row, $col) = @_; 890 my ($self, $row, $col) = @_;
716 891
717 ($row - $self->{beg}) * $self->{term}->ncol + $col 892 ($row - $self->{beg}) * $self->{ncol} + $col
718} 893}
719 894
720sub urxvt::line::coord_of { 895sub urxvt::line::coord_of {
721 my ($self, $offset) = @_; 896 my ($self, $offset) = @_;
722 897
723 use integer; 898 use integer;
724 899
725 ( 900 (
726 $offset / $self->{term}->ncol + $self->{beg}, 901 $offset / $self->{ncol} + $self->{beg},
727 $offset % $self->{term}->ncol 902 $offset % $self->{ncol}
728 ) 903 )
729} 904}
730 905
731=item ($row, $col) = $line->coord_of ($offset) 906=item ($row, $col) = $line->coord_of ($offset)
732=item $text = $term->special_encode $string 907=item $text = $term->special_encode $string
850This variable controls the verbosity level of the perl extension. Higher 1025This variable controls the verbosity level of the perl extension. Higher
851numbers indicate more verbose output. 1026numbers indicate more verbose output.
852 1027
853=over 4 1028=over 4
854 1029
855=item 0 - only fatal messages 1030=item =0 - only fatal messages
856 1031
857=item 3 - script loading and management 1032=item =3 - script loading and management
858 1033
859=item 10 - all events received 1034=item =10 - all events received
860 1035
861=back 1036=back
862 1037
863=head1 AUTHOR 1038=head1 AUTHOR
864 1039

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines