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.25 by root, Tue Jan 3 21:08:39 2006 UTC vs.
Revision 1.42 by root, Fri Jan 6 21:06:09 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
57=back 59=back
58 60
59=item digital-clock 61=item digital-clock
60 62
61Displays a digital clock using the built-in overlay. 63Displays a digital clock using the built-in overlay.
64
65=item mark-urls
66
67Uses per-line display filtering (C<on_line_update>) to underline urls.
68
69=item block-graphics-to-ascii
70
71A not very useful example of filtering all text output to the terminal,
72by replacing all line-drawing characters (U+2500 .. U+259F) by a
73similar-looking ascii character.
62 74
63=item example-refresh-hooks 75=item example-refresh-hooks
64 76
65Displays a very simple digital clock in the upper right corner of the 77Displays a very simple digital clock in the upper right corner of the
66window. Illustrates overwriting the refresh callbacks to create your own 78window. Illustrates overwriting the refresh callbacks to create your own
79When objects are destroyed on the C++ side, the perl object hashes are 91When objects are destroyed on the C++ side, the perl object hashes are
80emptied, so its best to store related objects such as time watchers and 92emptied, so its best to store related objects such as time watchers and
81the like inside the terminal object so they get destroyed as soon as the 93the like inside the terminal object so they get destroyed as soon as the
82terminal is destroyed. 94terminal is destroyed.
83 95
96Argument names also often indicate the type of a parameter. Here are some
97hints on what they mean:
98
99=over 4
100
101=item $text
102
103Rxvt-unicodes special way of encoding text, where one "unicode" character
104always represents one screen cell. See L<row_t> for a discussion of this format.
105
106=item $string
107
108A perl text string, with an emphasis on I<text>. It can store all unicode
109characters and is to be distinguished with text encoded in a specific
110encoding (often locale-specific) and binary data.
111
112=item $octets
113
114Either binary data or - more common - a text string encoded in a
115locale-specific way.
116
117=back
118
84=head2 Hooks 119=head2 Hooks
85 120
86The following subroutines can be declared in loaded scripts, and will be 121The following subroutines can be declared in loaded scripts, and will be
87called whenever the relevant event happens. 122called whenever the relevant event happens.
88 123
101=over 4 136=over 4
102 137
103=item on_init $term 138=item on_init $term
104 139
105Called after a new terminal object has been initialized, but before 140Called after a new terminal object has been initialized, but before
106windows are created or the command gets run. 141windows are created or the command gets run. Most methods are unsafe to
142call or deliver senseless data, as terminal size and other characteristics
143have not yet been determined. You can safely query and change resources,
144though.
107 145
108=item on_reset $term 146=item on_reset $term
109 147
110Called after the screen is "reset" for any reason, such as resizing or 148Called after the screen is "reset" for any reason, such as resizing or
111control sequences. Here is where you can react on changes to size-related 149control sequences. Here is where you can react on changes to size-related
170 208
171=item on_tty_activity $term *NYI* 209=item on_tty_activity $term *NYI*
172 210
173Called whenever the program(s) running in the urxvt window send output. 211Called whenever the program(s) running in the urxvt window send output.
174 212
213=item on_osc_seq $term, $string
214
215Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
216operating system command) is processed. Cursor position and other state
217information is up-to-date when this happens. For interoperability, the
218string should start with the extension name and a colon, to distinguish
219it from commands for other extensions, and this might be enforced in the
220future.
221
222Be careful not ever to trust (in a security sense) the data you receive,
223as its source can not easily be controleld (e-mail content, messages from
224other users on the same system etc.).
225
226=item on_add_lines $term, $string
227
228Called whenever text is about to be output, with the text as argument. You
229can filter/change and output the text yourself by returning a true value
230and calling C<< $term->scr_add_lines >> yourself. Please note that this
231might be very slow, however, as your hook is called for B<all> text being
232output.
233
234=item on_line_update $term, $row
235
236Called whenever a line was updated or changed. Can be used to filter
237screen output (e.g. underline urls or other useless stuff). Only lines
238that are being shown will be filtered, and, due to performance reasons,
239not always immediately.
240
241The row number is always the topmost row of the line if the line spans
242multiple rows.
243
244Please note that, if you change the line, then the hook might get called
245later with the already-modified line (e.g. if unrelated parts change), so
246you cannot just toggle rendition bits, but only set them.
247
175=item on_refresh_begin $term 248=item on_refresh_begin $term
176 249
177Called just before the screen gets redrawn. Can be used for overlay 250Called just before the screen gets redrawn. Can be used for overlay
178or similar effects by modify terminal contents in refresh_begin, and 251or similar effects by modify terminal contents in refresh_begin, and
179restoring them in refresh_end. The built-in overlay and selection display 252restoring them in refresh_end. The built-in overlay and selection display
187 260
188Called whenever the user presses a key combination that has a 261Called whenever the user presses a key combination that has a
189C<perl:string> action bound to it (see description of the B<keysym> 262C<perl:string> action bound to it (see description of the B<keysym>
190resource in the @@RXVT_NAME@@(1) manpage). 263resource in the @@RXVT_NAME@@(1) manpage).
191 264
265=item on_key_press $term, $event, $octets
266
267=item on_key_release $term, $event
268
269=item on_button_press $term, $event
270
271=item on_button_release $term, $event
272
273=item on_motion_notify $term, $event
274
275Called whenever the corresponding X event is received for the terminal If
276the hook returns true, then the even will be ignored by rxvt-unicode.
277
278The event is a hash with most values as named by Xlib (see the XEvent
279manpage), with the additional members C<row> and C<col>, which are the row
280and column under the mouse cursor.
281
282C<on_key_press> additionally receives the string rxvt-unicode would
283output, if any, in locale-specific encoding.
284
285subwindow.
286
192=back 287=back
193 288
194=head2 Variables in the C<urxvt> Package 289=head2 Variables in the C<urxvt> Package
195 290
196=over 4 291=over 4
203=back 298=back
204 299
205=head2 Functions in the C<urxvt> Package 300=head2 Functions in the C<urxvt> Package
206 301
207=over 4 302=over 4
303
304=item $term = new urxvt [arg...]
305
306Creates a new terminal, very similar as if you had started it with
307C<system $binfile, arg...>. Croaks (and probably outputs an error message)
308if the new instance couldn't be created. Returns C<undef> if the new
309instance didn't initialise perl, and the terminal object otherwise. The
310C<init> and C<start> hooks will be called during the call.
208 311
209=item urxvt::fatal $errormessage 312=item urxvt::fatal $errormessage
210 313
211Fatally aborts execution with the given error message. Avoid at all 314Fatally aborts execution with the given error message. Avoid at all
212costs! The only time this is acceptable is when the terminal process 315costs! The only time this is acceptable is when the terminal process
351 454
352 $pkg 455 $pkg
353 } 456 }
354} 457}
355 458
459our $retval; # return value for urxvt
460
356# called by the rxvt core 461# called by the rxvt core
357sub invoke { 462sub invoke {
358 local $TERM = shift; 463 local $TERM = shift;
359 my $htype = shift; 464 my $htype = shift;
360 465
361 if ($htype == 0) { # INIT 466 if ($htype == 0) { # INIT
362 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 467 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
363 468
364 for my $ext (split /:/, $TERM->resource ("perl_ext")) { 469 for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
365 my @files = grep -f $_, map "$_/$ext", @dirs; 470 my @files = grep -f $_, map "$_/$ext", @dirs;
366 471
367 if (@files) { 472 if (@files) {
368 register_package script_package $files[0]; 473 register_package script_package $files[0];
369 } else { 474 } else {
370 warn "perl extension '$ext' not found in perl library search path\n"; 475 warn "perl extension '$ext' not found in perl library search path\n";
371 } 476 }
372 } 477 }
478 }
373 479
480 $retval = undef;
481
482 if (my $cb = $TERM->{_hook}[$htype]) {
483 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
484 if $verbosity >= 10;
485
486 keys %$cb;
487
488 while (my ($pkg, $cb) = each %$cb) {
489 $retval = $cb->(
490 $TERM->{_pkg}{$pkg} ||= do {
491 my $proxy = bless { }, urxvt::term::proxy::;
492 Scalar::Util::weaken ($proxy->{term} = $TERM);
493 $proxy
494 },
495 @_,
496 ) and last;
497 }
498 }
499
374 } elsif ($htype == 1) { # DESTROY 500 if ($htype == 1) { # DESTROY
501 # remove hooks if unused
375 if (my $hook = $TERM->{_hook}) { 502 if (my $hook = $TERM->{_hook}) {
376 for my $htype (0..$#$hook) { 503 for my $htype (0..$#$hook) {
377 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } 504 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
378 or set_should_invoke $htype, 0; 505 or set_should_invoke $htype, 0;
379 } 506 }
380 } 507 }
508
509 # clear package objects
510 %$_ = () for values %{ $TERM->{_pkg} };
511
512 # clear package
513 %$TERM = ();
381 } 514 }
382 515
383 my $cb = $TERM->{_hook}[$htype] 516 $retval
384 or return;
385
386 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
387 if $verbosity >= 10;
388
389 keys %$cb;
390
391 while (my ($pkg, $cb) = each %$cb) {
392 return 1
393 if $cb->(
394 $TERM->{$pkg} ||= do {
395 my $proxy = bless { }, urxvt::term::proxy::;
396 Scalar::Util::weaken ($proxy->{term} = $TERM);
397 $proxy
398 },
399 @_,
400 );
401 }
402
403 0
404} 517}
405 518
406sub urxvt::term::proxy::AUTOLOAD { 519sub urxvt::term::proxy::AUTOLOAD {
407 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 520 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
408 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 521 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
420 533
421=head2 The C<urxvt::term> Class 534=head2 The C<urxvt::term> Class
422 535
423=over 4 536=over 4
424 537
538=item $term->destroy
539
540Destroy the terminal object (close the window, free resources etc.).
541
425=item $value = $term->resource ($name[, $newval]) 542=item $value = $term->resource ($name[, $newval])
426 543
427Returns the current resource value associated with a given name and 544Returns the current resource value associated with a given name and
428optionally sets a new value. Setting values is most useful in the C<init> 545optionally sets a new value. Setting values is most useful in the C<init>
429hook. Unset resources are returned and accepted as C<undef>. 546hook. Unset resources are returned and accepted as C<undef>.
446 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 563 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
447 borderLess color cursorBlink cursorUnderline cutchars delete_key 564 borderLess color cursorBlink cursorUnderline cutchars delete_key
448 display_name embed ext_bwidth fade font geometry hold iconName 565 display_name embed ext_bwidth fade font geometry hold iconName
449 imFont imLocale inputMethod insecure int_bwidth intensityStyles 566 imFont imLocale inputMethod insecure int_bwidth intensityStyles
450 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 567 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
451 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext 568 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
452 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 569 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
453 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 570 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
454 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 571 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
455 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 572 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
456 shade term_name title transparent transparent_all tripleclickwords 573 shade term_name title transparent transparent_all tripleclickwords
462 my ($self, $name) = (shift, shift); 579 my ($self, $name) = (shift, shift);
463 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 580 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
464 goto &urxvt::term::_resource; 581 goto &urxvt::term::_resource;
465} 582}
466 583
584=item $rend = $term->rstyle ([$new_rstyle])
585
586Return and optionally change the current rendition. Text that is output by
587the terminal application will use this style.
588
589=item ($row, $col) = $term->screen_cur ([$row, $col])
590
591Return the current coordinates of the text cursor position and optionally
592set it (which is usually bad as applications don't expect that).
593
467=item ($row, $col) = $term->selection_mark ([$row, $col]) 594=item ($row, $col) = $term->selection_mark ([$row, $col])
468 595
469=item ($row, $col) = $term->selection_beg ([$row, $col]) 596=item ($row, $col) = $term->selection_beg ([$row, $col])
470 597
471=item ($row, $col) = $term->selection_end ([$row, $col]) 598=item ($row, $col) = $term->selection_end ([$row, $col])
485#=item $term->overlay ($x, $y, $text) 612#=item $term->overlay ($x, $y, $text)
486# 613#
487#Create a simple multi-line overlay box. See the next method for details. 614#Create a simple multi-line overlay box. See the next method for details.
488# 615#
489#=cut 616#=cut
490 617#
491sub urxvt::term::scr_overlay { 618#sub urxvt::term::scr_overlay {
492die;
493 my ($self, $x, $y, $text) = @_; 619# my ($self, $x, $y, $text) = @_;
494 620#
495 my @lines = split /\n/, $text; 621# my @lines = split /\n/, $text;
496 622#
497 my $w = 0; 623# my $w = 0;
498 for (map $self->strwidth ($_), @lines) { 624# for (map $self->strwidth ($_), @lines) {
499 $w = $_ if $w < $_; 625# $w = $_ if $w < $_;
500 } 626# }
501 627#
502 $self->scr_overlay_new ($x, $y, $w, scalar @lines); 628# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
503 $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; 629# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
504} 630#}
505 631
506=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) 632=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
507 633
508Create a new (empty) overlay at the given position with the given 634Create a new (empty) overlay at the given position with the given
509width/height. C<$rstyle> defines the initial rendition style 635width/height. C<$rstyle> defines the initial rendition style
536 662
537If hidden, display the overlay again. 663If hidden, display the overlay again.
538 664
539=back 665=back
540 666
541=item $cellwidth = $term->strwidth $string 667=item $cellwidth = $term->strwidth ($string)
542 668
543Returns the number of screen-cells this string would need. Correctly 669Returns the number of screen-cells this string would need. Correctly
544accounts for wide and combining characters. 670accounts for wide and combining characters.
545 671
546=item $octets = $term->locale_encode $string 672=item $octets = $term->locale_encode ($string)
547 673
548Convert the given text string into the corresponding locale encoding. 674Convert the given text string into the corresponding locale encoding.
549 675
550=item $string = $term->locale_decode $octets 676=item $string = $term->locale_decode ($octets)
551 677
552Convert the given locale-encoded octets into a perl string. 678Convert the given locale-encoded octets into a perl string.
679
680=item $term->scr_add_lines ($string)
681
682Write the given text string to the screen, as if output by the application
683running inside the terminal. It may not contain command sequences (escape
684codes), but is free to use line feeds, carriage returns and tabs. The
685string is a normal text string, not in locale-dependent encoding.
686
687Normally its not a good idea to use this function, as programs might be
688confused by changes in cursor position or scrolling. Its useful inside a
689C<on_add_lines> hook, though.
690
691=item $term->cmd_parse ($octets)
692
693Similar to C<scr_add_lines>, but the argument must be in the
694locale-specific encoding of the terminal and can contain command sequences
695(escape codes) that will be interpreted.
553 696
554=item $term->tt_write ($octets) 697=item $term->tt_write ($octets)
555 698
556Write the octets given in C<$data> to the tty (i.e. as program input). To 699Write the octets given in C<$data> to the tty (i.e. as program input). To
557pass characters instead of octets, you should convert your strings first 700pass characters instead of octets, you should convert your strings first
558to the locale-specific encoding using C<< $term->locale_encode >>. 701to the locale-specific encoding using C<< $term->locale_encode >>.
559 702
703=item $windowid = $term->parent
704
705Return the window id of the toplevel window.
706
707=item $windowid = $term->vt
708
709Return the window id of the terminal window.
710
711=item $window_width = $term->width
712
713=item $window_height = $term->height
714
715=item $font_width = $term->fwidth
716
717=item $font_height = $term->fheight
718
719=item $font_ascent = $term->fbase
720
560=item $nrow = $term->nrow 721=item $terminal_rows = $term->nrow
561 722
562=item $ncol = $term->ncol 723=item $terminal_columns = $term->ncol
563 724
564Return the number of rows/columns of the terminal window (i.e. as 725=item $has_focus = $term->focus
565specified by C<-geometry>, excluding any scrollback).
566 726
567=item $nsaved = $term->nsaved 727=item $is_mapped = $term->mapped
568 728
569Returns the number of lines in the scrollback buffer. 729=item $max_scrollback = $term->saveLines
730
731=item $nrow_plus_saveLines = $term->total_rows
732
733=item $lines_in_scrollback = $term->nsaved
734
735Return various integers describing terminal characteristics.
570 736
571=item $view_start = $term->view_start ([$newvalue]) 737=item $view_start = $term->view_start ([$newvalue])
572 738
573Returns the negative row number of the topmost line. Minimum value is 739Returns the negative row number of the topmost line. Minimum value is
574C<0>, which displays the normal terminal contents. Larger values scroll 740C<0>, which displays the normal terminal contents. Larger values scroll
637about the logical line that row C<$row_number> is part of. It supports the 803about the logical line that row C<$row_number> is part of. It supports the
638following methods: 804following methods:
639 805
640=over 4 806=over 4
641 807
642=item $text = $line->t 808=item $text = $line->t ([$new_text])
643 809
644Returns the full text of the line, similar to C<ROW_t> 810Returns or replaces the full text of the line, similar to C<ROW_t>
645 811
646=item $rend = $line->r 812=item $rend = $line->r ([$new_rend])
647 813
648Returns the full rendition array of the line, similar to C<ROW_r> 814Returns or replaces the full rendition array of the line, similar to C<ROW_r>
649 815
650=item $length = $line->l 816=item $length = $line->l
651 817
652Returns the length of the line in cells, similar to C<ROW_l>. 818Returns the length of the line in cells, similar to C<ROW_l>.
653 819
682 848
683 bless { 849 bless {
684 term => $self, 850 term => $self,
685 beg => $beg, 851 beg => $beg,
686 end => $end, 852 end => $end,
853 ncol => $self->ncol,
687 len => ($end - $beg) * $self->ncol + $self->ROW_l ($end), 854 len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
688 }, urxvt::line:: 855 }, urxvt::line::
689} 856}
690 857
691sub urxvt::line::t { 858sub urxvt::line::t {
692 my ($self) = @_; 859 my ($self) = @_;
693 860
861 if (@_ > 1)
862 {
863 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
864 for $self->{beg} .. $self->{end};
865 }
866
867 defined wantarray &&
694 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), 868 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
695 0, $self->{len} 869 0, $self->{len}
696} 870}
697 871
698sub urxvt::line::r { 872sub urxvt::line::r {
699 my ($self) = @_; 873 my ($self) = @_;
700 874
875 if (@_ > 1)
876 {
877 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
878 for $self->{beg} .. $self->{end};
879 }
880
881 if (defined wantarray) {
701 my $rend = [ 882 my $rend = [
702 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} 883 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
703 ]; 884 ];
704 $#$rend = $self->{len} - 1; 885 $#$rend = $self->{len} - 1;
705 $rend 886 return $rend;
887 }
888
889 ()
706} 890}
707 891
708sub urxvt::line::beg { $_[0]{beg} } 892sub urxvt::line::beg { $_[0]{beg} }
709sub urxvt::line::end { $_[0]{end} } 893sub urxvt::line::end { $_[0]{end} }
710sub urxvt::line::l { $_[0]{len} } 894sub urxvt::line::l { $_[0]{len} }
711 895
712sub urxvt::line::offset_of { 896sub urxvt::line::offset_of {
713 my ($self, $row, $col) = @_; 897 my ($self, $row, $col) = @_;
714 898
715 ($row - $self->{beg}) * $self->{term}->ncol + $col 899 ($row - $self->{beg}) * $self->{ncol} + $col
716} 900}
717 901
718sub urxvt::line::coord_of { 902sub urxvt::line::coord_of {
719 my ($self, $offset) = @_; 903 my ($self, $offset) = @_;
720 904
721 use integer; 905 use integer;
722 906
723 ( 907 (
724 $offset / $self->{term}->ncol + $self->{beg}, 908 $offset / $self->{ncol} + $self->{beg},
725 $offset % $self->{term}->ncol 909 $offset % $self->{ncol}
726 ) 910 )
727} 911}
728 912
729=item ($row, $col) = $line->coord_of ($offset) 913=item ($row, $col) = $line->coord_of ($offset)
730=item $text = $term->special_encode $string 914=item $text = $term->special_encode $string
848This variable controls the verbosity level of the perl extension. Higher 1032This variable controls the verbosity level of the perl extension. Higher
849numbers indicate more verbose output. 1033numbers indicate more verbose output.
850 1034
851=over 4 1035=over 4
852 1036
853=item 0 - only fatal messages 1037=item =0 - only fatal messages
854 1038
855=item 3 - script loading and management 1039=item =3 - script loading and management
856 1040
857=item 10 - all events received 1041=item =10 - all events received
858 1042
859=back 1043=back
860 1044
861=head1 AUTHOR 1045=head1 AUTHOR
862 1046

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines