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.20 by root, Tue Jan 3 04:18:47 2006 UTC vs.
Revision 1.30 by root, Wed Jan 4 05:35:34 2006 UTC

39 39
40=over 4 40=over 4
41 41
42=item selection 42=item selection
43 43
44Miscellaneous selection modifications. 44Intelligent selection. This extension tries to be more intelligent when
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>.
48
49It also offers the following bindable event:
45 50
46=over 4 51=over 4
47 52
48=item rot13 53=item rot13
49 54
68=head2 General API Considerations 73=head2 General API Considerations
69 74
70All objects (such as terminals, time watchers etc.) are typical 75All objects (such as terminals, time watchers etc.) are typical
71reference-to-hash objects. The hash can be used to store anything you 76reference-to-hash objects. The hash can be used to store anything you
72like. All members starting with an underscore (such as C<_ptr> or 77like. All members starting with an underscore (such as C<_ptr> or
73C<_hook>) are reserved for internal uses and must not be accessed or 78C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
74modified). 79modified).
75 80
76When objects are destroyed on the C++ side, the perl object hashes are 81When objects are destroyed on the C++ side, the perl object hashes are
77emptied, so its best to store related objects such as time watchers and 82emptied, so its best to store related objects such as time watchers and
78the like inside the terminal object so they get destroyed as soon as the 83the like inside the terminal object so they get destroyed as soon as the
79terminal is destroyed. 84terminal is destroyed.
80 85
81=head2 Hooks 86=head2 Hooks
82 87
83The following subroutines can be declared in loaded scripts, and will be called 88The following subroutines can be declared in loaded scripts, and will be
84whenever the relevant event happens. 89called whenever the relevant event happens.
90
91The first argument passed to them is an object private to each terminal
92and extension package. You can call all C<urxvt::term> methods on it, but
93its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
94object that is shared between all packages is stored in the C<term>
95member.
85 96
86All of them must return a boolean value. If it is true, then the event 97All of them must return a boolean value. If it is true, then the event
87counts as being I<consumed>, and the invocation of other hooks is skipped, 98counts as being I<consumed>, and the invocation of other hooks is skipped,
88and the relevant action might not be carried out by the C++ code. 99and the relevant action might not be carried out by the C++ code.
89 100
122requested from the server. The selection text can be queried and changed 133requested from the server. The selection text can be queried and changed
123by calling C<< $term->selection >>. 134by calling C<< $term->selection >>.
124 135
125Returning a true value aborts selection grabbing. It will still be hilighted. 136Returning a true value aborts selection grabbing. It will still be hilighted.
126 137
138=item on_sel_extend $term
139
140Called whenever the user tries to extend the selection (e.g. with a double
141click) and is either supposed to return false (normal operation), or
142should extend the selection itelf and return true to suppress the built-in
143processing.
144
145See the F<selection> example extension.
146
127=item on_focus_in $term 147=item on_focus_in $term
128 148
129Called whenever the window gets the keyboard focus, before urxvt does 149Called whenever the window gets the keyboard focus, before urxvt does
130focus in processing. 150focus in processing.
131 151
151number of lines that will be in the scrollback buffer. 171number of lines that will be in the scrollback buffer.
152 172
153=item on_tty_activity $term *NYI* 173=item on_tty_activity $term *NYI*
154 174
155Called whenever the program(s) running in the urxvt window send output. 175Called whenever the program(s) running in the urxvt window send output.
176
177=item on_osc_seq $term, $string
178
179Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
180operating system command) is processed. Cursor position and other state
181information is up-to-date when this happens. For interoperability, the
182string should start with the extension name and a colon, to distinguish
183it from commands for other extensions, and this might be enforced in the
184future.
185
186Be careful not ever to trust (in a security sense) the data you receive,
187as its source can not easily be controleld (e-mail content, messages from
188other users on the same system etc.).
156 189
157=item on_refresh_begin $term 190=item on_refresh_begin $term
158 191
159Called just before the screen gets redrawn. Can be used for overlay 192Called just before the screen gets redrawn. Can be used for overlay
160or similar effects by modify terminal contents in refresh_begin, and 193or similar effects by modify terminal contents in refresh_begin, and
171C<perl:string> action bound to it (see description of the B<keysym> 204C<perl:string> action bound to it (see description of the B<keysym>
172resource in the @@RXVT_NAME@@(1) manpage). 205resource in the @@RXVT_NAME@@(1) manpage).
173 206
174=back 207=back
175 208
209=head2 Variables in the C<urxvt> Package
210
211=over 4
212
213=item $urxvt::TERM
214
215The current terminal. Whenever a callback/Hook is bein executed, this
216variable stores the current C<urxvt::term> object.
217
218=back
219
176=head2 Functions in the C<urxvt> Package 220=head2 Functions in the C<urxvt> Package
177 221
178=over 4 222=over 4
179 223
180=item urxvt::fatal $errormessage 224=item urxvt::fatal $errormessage
193correct place, e.g. on stderr of the connecting urxvtc client. 237correct place, e.g. on stderr of the connecting urxvtc client.
194 238
195=item $time = urxvt::NOW 239=item $time = urxvt::NOW
196 240
197Returns the "current time" (as per the event loop). 241Returns the "current time" (as per the event loop).
242
243=back
198 244
199=head2 RENDITION 245=head2 RENDITION
200 246
201Rendition bitsets contain information about colour, font, font styles and 247Rendition bitsets contain information about colour, font, font styles and
202similar information for each screen cell. 248similar information for each screen cell.
251=cut 297=cut
252 298
253package urxvt; 299package urxvt;
254 300
255use strict; 301use strict;
302use Scalar::Util ();
256 303
257our $term; 304our $TERM;
258our @HOOKNAME; 305our @HOOKNAME;
259our $LIBDIR; 306our $LIBDIR;
260 307
261BEGIN { 308BEGIN {
262 urxvt->bootstrap; 309 urxvt->bootstrap;
287 my $name = $HOOKNAME[$htype]; 334 my $name = $HOOKNAME[$htype];
288 335
289 my $ref = $pkg->can ("on_" . lc $name) 336 my $ref = $pkg->can ("on_" . lc $name)
290 or next; 337 or next;
291 338
292 $term->{_hook}[$htype]{$ref*1} = $ref; 339 $TERM->{_hook}[$htype]{$pkg} = $ref;
293 $hook_count[$htype]++ 340 $hook_count[$htype]++
294 or set_should_invoke $htype, 1; 341 or set_should_invoke $htype, 1;
295 } 342 }
296} 343}
297 344
321 } 368 }
322} 369}
323 370
324# called by the rxvt core 371# called by the rxvt core
325sub invoke { 372sub invoke {
326 local $term = shift; 373 local $TERM = shift;
327 my $htype = shift; 374 my $htype = shift;
328 375
329 if ($htype == 0) { # INIT 376 if ($htype == 0) { # INIT
330 my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl"); 377 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
331 378
332 for my $ext (split /:/, $term->resource ("perl_ext")) { 379 for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {
333 my @files = grep -f $_, map "$_/$ext", @dirs; 380 my @files = grep -f $_, map "$_/$ext", @dirs;
334 381
335 if (@files) { 382 if (@files) {
336 register_package script_package $files[0]; 383 register_package script_package $files[0];
337 } else { 384 } else {
338 warn "perl extension '$ext' not found in perl library search path\n"; 385 warn "perl extension '$ext' not found in perl library search path\n";
339 } 386 }
340 } 387 }
341 388
342 } elsif ($htype == 1) { # DESTROY 389 } elsif ($htype == 1) { # DESTROY
343 if (my $hook = $term->{_hook}) { 390 if (my $hook = $TERM->{_hook}) {
344 for my $htype (0..$#$hook) { 391 for my $htype (0..$#$hook) {
345 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } 392 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
346 or set_should_invoke $htype, 0; 393 or set_should_invoke $htype, 0;
347 } 394 }
348 } 395 }
349 } 396 }
350 397
351 my $cb = $term->{_hook}[$htype] 398 my $cb = $TERM->{_hook}[$htype]
352 or return; 399 or return;
353 400
354 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")" 401 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
355 if $verbosity >= 10; 402 if $verbosity >= 10;
356 403
404 keys %$cb;
405
357 while (my ($k, $v) = each %$cb) { 406 while (my ($pkg, $cb) = each %$cb) {
358 return 1 if $v->($term, @_); 407 return 1
408 if $cb->(
409 $TERM->{$pkg} ||= do {
410 my $proxy = bless { }, urxvt::term::proxy::;
411 Scalar::Util::weaken ($proxy->{term} = $TERM);
412 $proxy
413 },
414 @_,
415 );
359 } 416 }
360 417
361 0 418 0
362} 419}
363 420
364=back 421sub urxvt::term::proxy::AUTOLOAD {
422 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
423 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
424
425 eval qq{
426 sub $urxvt::term::proxy::AUTOLOAD {
427 my \$proxy = shift;
428 \$proxy->{term}->$1 (\@_)
429 }
430 1
431 } or die "FATAL: unable to compile method forwarder: $@";
432
433 goto &$urxvt::term::proxy::AUTOLOAD;
434}
365 435
366=head2 The C<urxvt::term> Class 436=head2 The C<urxvt::term> Class
367 437
368=over 4 438=over 4
369 439
391 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 461 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
392 borderLess color cursorBlink cursorUnderline cutchars delete_key 462 borderLess color cursorBlink cursorUnderline cutchars delete_key
393 display_name embed ext_bwidth fade font geometry hold iconName 463 display_name embed ext_bwidth fade font geometry hold iconName
394 imFont imLocale inputMethod insecure int_bwidth intensityStyles 464 imFont imLocale inputMethod insecure int_bwidth intensityStyles
395 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 465 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
396 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext 466 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
397 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 467 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
398 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 468 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
399 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 469 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
400 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 470 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
401 shade term_name title transparent transparent_all tripleclickwords 471 shade term_name title transparent transparent_all tripleclickwords
461right/bottom side, respectively. 531right/bottom side, respectively.
462 532
463This method returns an urxvt::overlay object. The overlay will be visible 533This method returns an urxvt::overlay object. The overlay will be visible
464as long as the perl object is referenced. 534as long as the perl object is referenced.
465 535
466Currently, the only method on the C<urxvt::overlay> object is C<set>: 536The methods currently supported on C<urxvt::overlay> objects are:
537
538=over 4
467 539
468=item $overlay->set ($x, $y, $text, $rend) 540=item $overlay->set ($x, $y, $text, $rend)
469 541
470Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 542Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
471text in rxvt-unicode's special encoding and an array of rendition values 543text in rxvt-unicode's special encoding and an array of rendition values
472at a specific position inside the overlay. 544at a specific position inside the overlay.
473 545
546=item $overlay->hide
547
548If visible, hide the overlay, but do not destroy it.
549
550=item $overlay->show
551
552If hidden, display the overlay again.
553
554=back
555
474=item $cellwidth = $term->strwidth $string 556=item $cellwidth = $term->strwidth $string
475 557
476Returns the number of screen-cells this string would need. Correctly 558Returns the number of screen-cells this string would need. Correctly
477accounts for wide and combining characters. 559accounts for wide and combining characters.
478 560
518=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 600=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
519 601
520Returns the text of the entire row with number C<$row_number>. Row C<0> 602Returns the text of the entire row with number C<$row_number>. Row C<0>
521is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 603is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
522terminal line. The scrollback buffer starts at line C<-1> and extends to 604terminal line. The scrollback buffer starts at line C<-1> and extends to
523line C<< -$term->nsaved >>. 605line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
606is requested.
524 607
525If C<$new_text> is specified, it will replace characters in the current 608If C<$new_text> is specified, it will replace characters in the current
526line, starting at column C<$start_col> (default C<0>), which is useful 609line, starting at column C<$start_col> (default C<0>), which is useful
527to replace only parts of a line. The font index in the rendition will 610to replace only parts of a line. The font index in the rendition will
528automatically be updated. 611automatically be updated.
550 633
551See the section on RENDITION, above. 634See the section on RENDITION, above.
552 635
553=item $length = $term->ROW_l ($row_number[, $new_length]) 636=item $length = $term->ROW_l ($row_number[, $new_length])
554 637
555Returns the number of screen cells that are in use ("the line length"). If 638Returns the number of screen cells that are in use ("the line
556it is C<-1>, then the line is part of a multiple-row logical "line", which 639length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
557means all characters are in use and it is continued on the next row. 640line is joined with the following one.
558 641
642=item $bool = $term->is_longer ($row_number)
643
644Returns true if the row is part of a multiple-row logical "line" (i.e.
645joined with the following row), which means all characters are in use
646and it is continued on the next row (and possibly a continuation of the
647previous row(s)).
648
649=item $line = $term->line ($row_number)
650
651Create and return a new C<urxvt::line> object that stores information
652about the logical line that row C<$row_number> is part of. It supports the
653following methods:
654
655=over 4
656
657=item $text = $line->t
658
659Returns the full text of the line, similar to C<ROW_t>
660
661=item $rend = $line->r
662
663Returns the full rendition array of the line, similar to C<ROW_r>
664
665=item $length = $line->l
666
667Returns the length of the line in cells, similar to C<ROW_l>.
668
669=item $rownum = $line->beg
670
671=item $rownum = $line->end
672
673Return the row number of the first/last row of the line, respectively.
674
675=item $offset = $line->offset_of ($row, $col)
676
677Returns the character offset of the given row|col pair within the logical
678line.
679
680=item ($row, $col) = $line->coord_of ($offset)
681
682Translates a string offset into terminal coordinates again.
683
684=back
685
686=cut
687
688sub urxvt::term::line {
689 my ($self, $row) = @_;
690
691 my $maxrow = $self->nrow - 1;
692
693 my ($beg, $end) = ($row, $row);
694
695 --$beg while $self->ROW_is_longer ($beg - 1);
696 ++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
697
698 bless {
699 term => $self,
700 beg => $beg,
701 end => $end,
702 len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
703 }, urxvt::line::
704}
705
706sub urxvt::line::t {
707 my ($self) = @_;
708
709 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
710 0, $self->{len}
711}
712
713sub urxvt::line::r {
714 my ($self) = @_;
715
716 my $rend = [
717 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
718 ];
719 $#$rend = $self->{len} - 1;
720 $rend
721}
722
723sub urxvt::line::beg { $_[0]{beg} }
724sub urxvt::line::end { $_[0]{end} }
725sub urxvt::line::l { $_[0]{len} }
726
727sub urxvt::line::offset_of {
728 my ($self, $row, $col) = @_;
729
730 ($row - $self->{beg}) * $self->{term}->ncol + $col
731}
732
733sub urxvt::line::coord_of {
734 my ($self, $offset) = @_;
735
736 use integer;
737
738 (
739 $offset / $self->{term}->ncol + $self->{beg},
740 $offset % $self->{term}->ncol
741 )
742}
743
744=item ($row, $col) = $line->coord_of ($offset)
559=item $text = $term->special_encode $string 745=item $text = $term->special_encode $string
560 746
561Converts a perl string into the special encoding used by rxvt-unicode, 747Converts a perl string into the special encoding used by rxvt-unicode,
562where one character corresponds to one screen cell. See 748where one character corresponds to one screen cell. See
563C<< $term->ROW_t >> for details. 749C<< $term->ROW_t >> for details.
677This variable controls the verbosity level of the perl extension. Higher 863This variable controls the verbosity level of the perl extension. Higher
678numbers indicate more verbose output. 864numbers indicate more verbose output.
679 865
680=over 4 866=over 4
681 867
682=item 0 - only fatal messages 868=item =0 - only fatal messages
683 869
684=item 3 - script loading and management 870=item =3 - script loading and management
685 871
686=item 10 - all events received 872=item =10 - all events received
687 873
688=back 874=back
689 875
690=head1 AUTHOR 876=head1 AUTHOR
691 877

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines