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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines