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.19 by root, Tue Jan 3 02:42:17 2006 UTC vs.
Revision 1.31 by root, Wed Jan 4 19:39:46 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
52 URxvt.keysym.C-M-r: perl:selection:rot13 57 URxvt.keysym.C-M-r: perl:selection:rot13
53 58
54=back 59=back
55 60
56=item digital-clock 61=item digital-clock
62
63Displays a digital clock using the built-in overlay.
64
65=item example-refresh-hooks
57 66
58Displays a very simple digital clock in the upper right corner of the 67Displays a very simple digital clock in the upper right corner of the
59window. Illustrates overwriting the refresh callbacks to create your own 68window. Illustrates overwriting the refresh callbacks to create your own
60overlays or changes. 69overlays or changes.
61 70
62=item simple-overlay-clock
63
64Displays a digital clock using the built-in overlay (colourful, useless).
65
66=back 71=back
67 72
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
319 366
320 $pkg 367 $pkg
321 } 368 }
322} 369}
323 370
371our $retval; # return value for urxvt
372
324# called by the rxvt core 373# called by the rxvt core
325sub invoke { 374sub invoke {
326 local $term = shift; 375 local $TERM = shift;
327 my $htype = shift; 376 my $htype = shift;
328 377
329 if ($htype == 0) { # INIT 378 if ($htype == 0) { # INIT
330 my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl"); 379 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
331 380
332 for my $ext (split /:/, $term->resource ("perl_ext")) { 381 for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {
333 my @files = grep -f $_, map "$_/$ext", @dirs; 382 my @files = grep -f $_, map "$_/$ext", @dirs;
334 383
335 if (@files) { 384 if (@files) {
336 register_package script_package $files[0]; 385 register_package script_package $files[0];
337 } else { 386 } else {
338 warn "perl extension '$ext' not found in perl library search path\n"; 387 warn "perl extension '$ext' not found in perl library search path\n";
339 } 388 }
340 } 389 }
390 }
341 391
392 $retval = undef;
393
394 if (my $cb = $TERM->{_hook}[$htype]) {
395 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
396 if $verbosity >= 10;
397
398 keys %$cb;
399
400 while (my ($pkg, $cb) = each %$cb) {
401 $retval = $cb->(
402 $TERM->{_pkg}{$pkg} ||= do {
403 my $proxy = bless { }, urxvt::term::proxy::;
404 Scalar::Util::weaken ($proxy->{term} = $TERM);
405 $proxy
406 },
407 @_,
408 ) and last;
409 }
410 }
411
342 } elsif ($htype == 1) { # DESTROY 412 if ($htype == 1) { # DESTROY
413 # remove hooks if unused
343 if (my $hook = $term->{_hook}) { 414 if (my $hook = $TERM->{_hook}) {
344 for my $htype (0..$#$hook) { 415 for my $htype (0..$#$hook) {
345 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } 416 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
346 or set_should_invoke $htype, 0; 417 or set_should_invoke $htype, 0;
347 } 418 }
348 } 419 }
420
421 # clear package objects
422 %$_ = () for values %{ $TERM->{_pkg} };
423
424 # clear package
425 %$TERM = ();
349 } 426 }
350 427
351 my $cb = $term->{_hook}[$htype] 428 $retval
352 or return;
353
354 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"
355 if $verbosity >= 10;
356
357 while (my ($k, $v) = each %$cb) {
358 return 1 if $v->($term, @_);
359 }
360
361 0
362} 429}
363 430
364=back 431sub urxvt::term::proxy::AUTOLOAD {
432 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
433 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
434
435 eval qq{
436 sub $urxvt::term::proxy::AUTOLOAD {
437 my \$proxy = shift;
438 \$proxy->{term}->$1 (\@_)
439 }
440 1
441 } or die "FATAL: unable to compile method forwarder: $@";
442
443 goto &$urxvt::term::proxy::AUTOLOAD;
444}
365 445
366=head2 The C<urxvt::term> Class 446=head2 The C<urxvt::term> Class
367 447
368=over 4 448=over 4
369 449
391 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 471 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
392 borderLess color cursorBlink cursorUnderline cutchars delete_key 472 borderLess color cursorBlink cursorUnderline cutchars delete_key
393 display_name embed ext_bwidth fade font geometry hold iconName 473 display_name embed ext_bwidth fade font geometry hold iconName
394 imFont imLocale inputMethod insecure int_bwidth intensityStyles 474 imFont imLocale inputMethod insecure int_bwidth intensityStyles
395 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 475 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
396 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext 476 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
397 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 477 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
398 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 478 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
399 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 479 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
400 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 480 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
401 shade term_name title transparent transparent_all tripleclickwords 481 shade term_name title transparent transparent_all tripleclickwords
425 505
426=item $oldtext = $term->selection ([$newtext]) 506=item $oldtext = $term->selection ([$newtext])
427 507
428Return the current selection text and optionally replace it by C<$newtext>. 508Return the current selection text and optionally replace it by C<$newtext>.
429 509
430=item $term->scr_overlay ($x, $y, $text) 510#=item $term->overlay ($x, $y, $text)
431 511#
432Create a simple multi-line overlay box. See the next method for details. 512#Create a simple multi-line overlay box. See the next method for details.
433 513#
434=cut 514#=cut
435 515
436sub urxvt::term::scr_overlay { 516sub urxvt::term::scr_overlay {
517die;
437 my ($self, $x, $y, $text) = @_; 518 my ($self, $x, $y, $text) = @_;
438 519
439 my @lines = split /\n/, $text; 520 my @lines = split /\n/, $text;
440 521
441 my $w = 0; 522 my $w = 0;
445 526
446 $self->scr_overlay_new ($x, $y, $w, scalar @lines); 527 $self->scr_overlay_new ($x, $y, $w, scalar @lines);
447 $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; 528 $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
448} 529}
449 530
450=item $term->scr_overlay_new ($x, $y, $width, $height) 531=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
451 532
452Create a new (empty) overlay at the given position with the given 533Create a new (empty) overlay at the given position with the given
453width/height. A border will be put around the box. If either C<$x> or 534width/height. C<$rstyle> defines the initial rendition style
454C<$y> is negative, then this is counted from the right/bottom side, 535(default: C<OVERLAY_RSTYLE>).
455respectively.
456 536
457=item $term->scr_overlay_off 537If C<$border> is C<2> (default), then a decorative border will be put
538around the box.
458 539
459Switch the overlay off again. 540If either C<$x> or C<$y> is negative, then this is counted from the
541right/bottom side, respectively.
460 542
461=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE) 543This method returns an urxvt::overlay object. The overlay will be visible
544as long as the perl object is referenced.
462 545
463Put a single character (specified numerically) at the given overlay 546The methods currently supported on C<urxvt::overlay> objects are:
464position.
465 547
548=over 4
549
466=item $term->scr_overlay_set ($x, $y, $text) 550=item $overlay->set ($x, $y, $text, $rend)
467 551
468Write a string at the given position into the overlay. 552Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
553text in rxvt-unicode's special encoding and an array of rendition values
554at a specific position inside the overlay.
555
556=item $overlay->hide
557
558If visible, hide the overlay, but do not destroy it.
559
560=item $overlay->show
561
562If hidden, display the overlay again.
563
564=back
469 565
470=item $cellwidth = $term->strwidth $string 566=item $cellwidth = $term->strwidth $string
471 567
472Returns the number of screen-cells this string would need. Correctly 568Returns the number of screen-cells this string would need. Correctly
473accounts for wide and combining characters. 569accounts for wide and combining characters.
514=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 610=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
515 611
516Returns the text of the entire row with number C<$row_number>. Row C<0> 612Returns the text of the entire row with number C<$row_number>. Row C<0>
517is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 613is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
518terminal line. The scrollback buffer starts at line C<-1> and extends to 614terminal line. The scrollback buffer starts at line C<-1> and extends to
519line C<< -$term->nsaved >>. 615line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
616is requested.
520 617
521If C<$new_text> is specified, it will replace characters in the current 618If C<$new_text> is specified, it will replace characters in the current
522line, starting at column C<$start_col> (default C<0>), which is useful 619line, starting at column C<$start_col> (default C<0>), which is useful
523to replace only parts of a line. The font index in the rendition will 620to replace only parts of a line. The font index in the rendition will
524automatically be updated. 621automatically be updated.
546 643
547See the section on RENDITION, above. 644See the section on RENDITION, above.
548 645
549=item $length = $term->ROW_l ($row_number[, $new_length]) 646=item $length = $term->ROW_l ($row_number[, $new_length])
550 647
551Returns the number of screen cells that are in use ("the line length"). If 648Returns the number of screen cells that are in use ("the line
552it is C<-1>, then the line is part of a multiple-row logical "line", which 649length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
553means all characters are in use and it is continued on the next row. 650line is joined with the following one.
554 651
652=item $bool = $term->is_longer ($row_number)
653
654Returns true if the row is part of a multiple-row logical "line" (i.e.
655joined with the following row), which means all characters are in use
656and it is continued on the next row (and possibly a continuation of the
657previous row(s)).
658
659=item $line = $term->line ($row_number)
660
661Create and return a new C<urxvt::line> object that stores information
662about the logical line that row C<$row_number> is part of. It supports the
663following methods:
664
665=over 4
666
667=item $text = $line->t
668
669Returns the full text of the line, similar to C<ROW_t>
670
671=item $rend = $line->r
672
673Returns the full rendition array of the line, similar to C<ROW_r>
674
675=item $length = $line->l
676
677Returns the length of the line in cells, similar to C<ROW_l>.
678
679=item $rownum = $line->beg
680
681=item $rownum = $line->end
682
683Return the row number of the first/last row of the line, respectively.
684
685=item $offset = $line->offset_of ($row, $col)
686
687Returns the character offset of the given row|col pair within the logical
688line.
689
690=item ($row, $col) = $line->coord_of ($offset)
691
692Translates a string offset into terminal coordinates again.
693
694=back
695
696=cut
697
698sub urxvt::term::line {
699 my ($self, $row) = @_;
700
701 my $maxrow = $self->nrow - 1;
702
703 my ($beg, $end) = ($row, $row);
704
705 --$beg while $self->ROW_is_longer ($beg - 1);
706 ++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
707
708 bless {
709 term => $self,
710 beg => $beg,
711 end => $end,
712 len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
713 }, urxvt::line::
714}
715
716sub urxvt::line::t {
717 my ($self) = @_;
718
719 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
720 0, $self->{len}
721}
722
723sub urxvt::line::r {
724 my ($self) = @_;
725
726 my $rend = [
727 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
728 ];
729 $#$rend = $self->{len} - 1;
730 $rend
731}
732
733sub urxvt::line::beg { $_[0]{beg} }
734sub urxvt::line::end { $_[0]{end} }
735sub urxvt::line::l { $_[0]{len} }
736
737sub urxvt::line::offset_of {
738 my ($self, $row, $col) = @_;
739
740 ($row - $self->{beg}) * $self->{term}->ncol + $col
741}
742
743sub urxvt::line::coord_of {
744 my ($self, $offset) = @_;
745
746 use integer;
747
748 (
749 $offset / $self->{term}->ncol + $self->{beg},
750 $offset % $self->{term}->ncol
751 )
752}
753
754=item ($row, $col) = $line->coord_of ($offset)
555=item $text = $term->special_encode $string 755=item $text = $term->special_encode $string
556 756
557Converts a perl string into the special encoding used by rxvt-unicode, 757Converts a perl string into the special encoding used by rxvt-unicode,
558where one character corresponds to one screen cell. See 758where one character corresponds to one screen cell. See
559C<< $term->ROW_t >> for details. 759C<< $term->ROW_t >> for details.
568=head2 The C<urxvt::timer> Class 768=head2 The C<urxvt::timer> Class
569 769
570This class implements timer watchers/events. Time is represented as a 770This class implements timer watchers/events. Time is represented as a
571fractional number of seconds since the epoch. Example: 771fractional number of seconds since the epoch. Example:
572 772
573 # create a digital clock display in upper right corner 773 $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
574 $term->{timer} = urxvt::timer 774 $term->{timer} = urxvt::timer
575 ->new 775 ->new
576 ->start (urxvt::NOW) 776 ->interval (1)
577 ->cb (sub { 777 ->cb (sub {
578 my ($timer) = @_;
579 my $time = $timer->at;
580 $timer->start ($time + 1);
581 $self->scr_overlay (-1, 0, 778 $term->{overlay}->set (0, 0,
582 POSIX::strftime "%H:%M:%S", localtime $time); 779 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
583 }); 780 });
584 781
585=over 4 782=over 4
586 783
587=item $timer = new urxvt::timer 784=item $timer = new urxvt::timer
588 785
589Create a new timer object in stopped state. 786Create a new timer object in started state. It is scheduled to fire
787immediately.
590 788
591=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 789=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
592 790
593Set the callback to be called when the timer triggers. 791Set the callback to be called when the timer triggers.
594 792
597Return the time this watcher will fire next. 795Return the time this watcher will fire next.
598 796
599=item $timer = $timer->set ($tstamp) 797=item $timer = $timer->set ($tstamp)
600 798
601Set the time the event is generated to $tstamp. 799Set the time the event is generated to $tstamp.
800
801=item $timer = $timer->interval ($interval)
802
803Normally (and when C<$interval> is C<0>), the timer will automatically
804stop after it has fired once. If C<$interval> is non-zero, then the timer
805is automatically rescheduled at the given intervals.
602 806
603=item $timer = $timer->start 807=item $timer = $timer->start
604 808
605Start the timer. 809Start the timer.
606 810
669This variable controls the verbosity level of the perl extension. Higher 873This variable controls the verbosity level of the perl extension. Higher
670numbers indicate more verbose output. 874numbers indicate more verbose output.
671 875
672=over 4 876=over 4
673 877
674=item 0 - only fatal messages 878=item =0 - only fatal messages
675 879
676=item 3 - script loading and management 880=item =3 - script loading and management
677 881
678=item 10 - all events received 882=item =10 - all events received
679 883
680=back 884=back
681 885
682=head1 AUTHOR 886=head1 AUTHOR
683 887

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines