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.38 by root, Fri Jan 6 03:43:12 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 filtering (C<on_line_update>) to underline urls.
62 68
63=item example-refresh-hooks 69=item example-refresh-hooks
64 70
65Displays 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
66window. Illustrates overwriting the refresh callbacks to create your own 72window. Illustrates overwriting the refresh callbacks to create your own
67overlays 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.
68 81
69=back 82=back
70 83
71=head2 General API Considerations 84=head2 General API Considerations
72 85
79When 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
80emptied, 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
81the 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
82terminal is destroyed. 95terminal is destroyed.
83 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
84=head2 Hooks 120=head2 Hooks
85 121
86The following subroutines can be declared in loaded scripts, and will be 122The following subroutines can be declared in loaded scripts, and will be
87called whenever the relevant event happens. 123called whenever the relevant event happens.
88 124
101=over 4 137=over 4
102 138
103=item on_init $term 139=item on_init $term
104 140
105Called after a new terminal object has been initialized, but before 141Called after a new terminal object has been initialized, but before
106windows 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.
107 146
108=item on_reset $term 147=item on_reset $term
109 148
110Called 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
111control 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
170 209
171=item on_tty_activity $term *NYI* 210=item on_tty_activity $term *NYI*
172 211
173Called whenever the program(s) running in the urxvt window send output. 212Called whenever the program(s) running in the urxvt window send output.
174 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
175=item on_refresh_begin $term 249=item on_refresh_begin $term
176 250
177Called just before the screen gets redrawn. Can be used for overlay 251Called just before the screen gets redrawn. Can be used for overlay
178or similar effects by modify terminal contents in refresh_begin, and 252or similar effects by modify terminal contents in refresh_begin, and
179restoring them in refresh_end. The built-in overlay and selection display 253restoring them in refresh_end. The built-in overlay and selection display
187 261
188Called whenever the user presses a key combination that has a 262Called whenever the user presses a key combination that has a
189C<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>
190resource in the @@RXVT_NAME@@(1) manpage). 264resource in the @@RXVT_NAME@@(1) manpage).
191 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
192=back 285=back
193 286
194=head2 Variables in the C<urxvt> Package 287=head2 Variables in the C<urxvt> Package
195 288
196=over 4 289=over 4
203=back 296=back
204 297
205=head2 Functions in the C<urxvt> Package 298=head2 Functions in the C<urxvt> Package
206 299
207=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.
208 309
209=item urxvt::fatal $errormessage 310=item urxvt::fatal $errormessage
210 311
211Fatally aborts execution with the given error message. Avoid at all 312Fatally aborts execution with the given error message. Avoid at all
212costs! The only time this is acceptable is when the terminal process 313costs! The only time this is acceptable is when the terminal process
351 452
352 $pkg 453 $pkg
353 } 454 }
354} 455}
355 456
457our $retval; # return value for urxvt
458
356# called by the rxvt core 459# called by the rxvt core
357sub invoke { 460sub invoke {
358 local $TERM = shift; 461 local $TERM = shift;
359 my $htype = shift; 462 my $htype = shift;
360 463
361 if ($htype == 0) { # INIT 464 if ($htype == 0) { # INIT
362 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 465 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
363 466
364 for my $ext (split /:/, $TERM->resource ("perl_ext")) { 467 for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {
365 my @files = grep -f $_, map "$_/$ext", @dirs; 468 my @files = grep -f $_, map "$_/$ext", @dirs;
366 469
367 if (@files) { 470 if (@files) {
368 register_package script_package $files[0]; 471 register_package script_package $files[0];
369 } else { 472 } else {
370 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";
371 } 474 }
372 } 475 }
476 }
373 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
374 } elsif ($htype == 1) { # DESTROY 498 if ($htype == 1) { # DESTROY
499 # remove hooks if unused
375 if (my $hook = $TERM->{_hook}) { 500 if (my $hook = $TERM->{_hook}) {
376 for my $htype (0..$#$hook) { 501 for my $htype (0..$#$hook) {
377 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } 502 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
378 or set_should_invoke $htype, 0; 503 or set_should_invoke $htype, 0;
379 } 504 }
380 } 505 }
506
507 # clear package objects
508 %$_ = () for values %{ $TERM->{_pkg} };
509
510 # clear package
511 %$TERM = ();
381 } 512 }
382 513
383 my $cb = $TERM->{_hook}[$htype] 514 $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} 515}
405 516
406sub urxvt::term::proxy::AUTOLOAD { 517sub urxvt::term::proxy::AUTOLOAD {
407 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 518 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
408 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 519 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
420 531
421=head2 The C<urxvt::term> Class 532=head2 The C<urxvt::term> Class
422 533
423=over 4 534=over 4
424 535
536=item $term->destroy
537
538Destroy the terminal object (close the window, free resources etc.).
539
425=item $value = $term->resource ($name[, $newval]) 540=item $value = $term->resource ($name[, $newval])
426 541
427Returns the current resource value associated with a given name and 542Returns the current resource value associated with a given name and
428optionally 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>
429hook. Unset resources are returned and accepted as C<undef>. 544hook. Unset resources are returned and accepted as C<undef>.
446 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 561 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
447 borderLess color cursorBlink cursorUnderline cutchars delete_key 562 borderLess color cursorBlink cursorUnderline cutchars delete_key
448 display_name embed ext_bwidth fade font geometry hold iconName 563 display_name embed ext_bwidth fade font geometry hold iconName
449 imFont imLocale inputMethod insecure int_bwidth intensityStyles 564 imFont imLocale inputMethod insecure int_bwidth intensityStyles
450 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 565 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
451 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext 566 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
452 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 567 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
453 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 568 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
454 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 569 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
455 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 570 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
456 shade term_name title transparent transparent_all tripleclickwords 571 shade term_name title transparent transparent_all tripleclickwords
462 my ($self, $name) = (shift, shift); 577 my ($self, $name) = (shift, shift);
463 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 578 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
464 goto &urxvt::term::_resource; 579 goto &urxvt::term::_resource;
465} 580}
466 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
467=item ($row, $col) = $term->selection_mark ([$row, $col]) 592=item ($row, $col) = $term->selection_mark ([$row, $col])
468 593
469=item ($row, $col) = $term->selection_beg ([$row, $col]) 594=item ($row, $col) = $term->selection_beg ([$row, $col])
470 595
471=item ($row, $col) = $term->selection_end ([$row, $col]) 596=item ($row, $col) = $term->selection_end ([$row, $col])
485#=item $term->overlay ($x, $y, $text) 610#=item $term->overlay ($x, $y, $text)
486# 611#
487#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.
488# 613#
489#=cut 614#=cut
490 615#
491sub urxvt::term::scr_overlay { 616#sub urxvt::term::scr_overlay {
492die;
493 my ($self, $x, $y, $text) = @_; 617# my ($self, $x, $y, $text) = @_;
494 618#
495 my @lines = split /\n/, $text; 619# my @lines = split /\n/, $text;
496 620#
497 my $w = 0; 621# my $w = 0;
498 for (map $self->strwidth ($_), @lines) { 622# for (map $self->strwidth ($_), @lines) {
499 $w = $_ if $w < $_; 623# $w = $_ if $w < $_;
500 } 624# }
501 625#
502 $self->scr_overlay_new ($x, $y, $w, scalar @lines); 626# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
503 $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; 627# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
504} 628#}
505 629
506=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) 630=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
507 631
508Create a new (empty) overlay at the given position with the given 632Create a new (empty) overlay at the given position with the given
509width/height. C<$rstyle> defines the initial rendition style 633width/height. C<$rstyle> defines the initial rendition style
549 673
550=item $string = $term->locale_decode $octets 674=item $string = $term->locale_decode $octets
551 675
552Convert the given locale-encoded octets into a perl string. 676Convert the given locale-encoded octets into a perl string.
553 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
554=item $term->tt_write ($octets) 695=item $term->tt_write ($octets)
555 696
556Write 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
557pass characters instead of octets, you should convert your strings first 698pass characters instead of octets, you should convert your strings first
558to the locale-specific encoding using C<< $term->locale_encode >>. 699to the locale-specific encoding using C<< $term->locale_encode >>.
559 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
560=item $nrow = $term->nrow 711=item $terminal_rows = $term->nrow
561 712
562=item $ncol = $term->ncol 713=item $terminal_columns = $term->ncol
563 714
564Return the number of rows/columns of the terminal window (i.e. as 715=item $has_focus = $term->focus
565specified by C<-geometry>, excluding any scrollback).
566 716
567=item $nsaved = $term->nsaved 717=item $is_mapped = $term->mapped
568 718
569Returns 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.
570 726
571=item $view_start = $term->view_start ([$newvalue]) 727=item $view_start = $term->view_start ([$newvalue])
572 728
573Returns the negative row number of the topmost line. Minimum value is 729Returns the negative row number of the topmost line. Minimum value is
574C<0>, which displays the normal terminal contents. Larger values scroll 730C<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 793about the logical line that row C<$row_number> is part of. It supports the
638following methods: 794following methods:
639 795
640=over 4 796=over 4
641 797
642=item $text = $line->t 798=item $text = $line->t ([$new_text])
643 799
644Returns 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>
645 801
646=item $rend = $line->r 802=item $rend = $line->r ([$new_rend])
647 803
648Returns 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>
649 805
650=item $length = $line->l 806=item $length = $line->l
651 807
652Returns 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>.
653 809
682 838
683 bless { 839 bless {
684 term => $self, 840 term => $self,
685 beg => $beg, 841 beg => $beg,
686 end => $end, 842 end => $end,
843 ncol => $self->ncol,
687 len => ($end - $beg) * $self->ncol + $self->ROW_l ($end), 844 len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
688 }, urxvt::line:: 845 }, urxvt::line::
689} 846}
690 847
691sub urxvt::line::t { 848sub urxvt::line::t {
692 my ($self) = @_; 849 my ($self) = @_;
693 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 &&
694 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), 858 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
695 0, $self->{len} 859 0, $self->{len}
696} 860}
697 861
698sub urxvt::line::r { 862sub urxvt::line::r {
699 my ($self) = @_; 863 my ($self) = @_;
700 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) {
701 my $rend = [ 872 my $rend = [
702 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} 873 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
703 ]; 874 ];
704 $#$rend = $self->{len} - 1; 875 $#$rend = $self->{len} - 1;
705 $rend 876 return $rend;
877 }
878
879 ()
706} 880}
707 881
708sub urxvt::line::beg { $_[0]{beg} } 882sub urxvt::line::beg { $_[0]{beg} }
709sub urxvt::line::end { $_[0]{end} } 883sub urxvt::line::end { $_[0]{end} }
710sub urxvt::line::l { $_[0]{len} } 884sub urxvt::line::l { $_[0]{len} }
711 885
712sub urxvt::line::offset_of { 886sub urxvt::line::offset_of {
713 my ($self, $row, $col) = @_; 887 my ($self, $row, $col) = @_;
714 888
715 ($row - $self->{beg}) * $self->{term}->ncol + $col 889 ($row - $self->{beg}) * $self->{ncol} + $col
716} 890}
717 891
718sub urxvt::line::coord_of { 892sub urxvt::line::coord_of {
719 my ($self, $offset) = @_; 893 my ($self, $offset) = @_;
720 894
721 use integer; 895 use integer;
722 896
723 ( 897 (
724 $offset / $self->{term}->ncol + $self->{beg}, 898 $offset / $self->{ncol} + $self->{beg},
725 $offset % $self->{term}->ncol 899 $offset % $self->{ncol}
726 ) 900 )
727} 901}
728 902
729=item ($row, $col) = $line->coord_of ($offset) 903=item ($row, $col) = $line->coord_of ($offset)
730=item $text = $term->special_encode $string 904=item $text = $term->special_encode $string
848This variable controls the verbosity level of the perl extension. Higher 1022This variable controls the verbosity level of the perl extension. Higher
849numbers indicate more verbose output. 1023numbers indicate more verbose output.
850 1024
851=over 4 1025=over 4
852 1026
853=item 0 - only fatal messages 1027=item =0 - only fatal messages
854 1028
855=item 3 - script loading and management 1029=item =3 - script loading and management
856 1030
857=item 10 - all events received 1031=item =10 - all events received
858 1032
859=back 1033=back
860 1034
861=head1 AUTHOR 1035=head1 AUTHOR
862 1036

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines