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.17 by root, Tue Jan 3 01:45:03 2006 UTC vs.
Revision 1.28 by root, Wed Jan 4 00:09:12 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 (colorful, 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 is
180processed. Cursor position and other state information is up-to-date when
181this happens. For interoperability, the string should start with the
182extension name and a colon, to distinguish it from commands for other
183extensions, and this might be enforced in the future.
156 184
157=item on_refresh_begin $term 185=item on_refresh_begin $term
158 186
159Called just before the screen gets redrawn. Can be used for overlay 187Called just before the screen gets redrawn. Can be used for overlay
160or similar effects by modify terminal contents in refresh_begin, and 188or similar effects by modify terminal contents in refresh_begin, and
171C<perl:string> action bound to it (see description of the B<keysym> 199C<perl:string> action bound to it (see description of the B<keysym>
172resource in the @@RXVT_NAME@@(1) manpage). 200resource in the @@RXVT_NAME@@(1) manpage).
173 201
174=back 202=back
175 203
204=head2 Variables in the C<urxvt> Package
205
206=over 4
207
208=item $urxvt::TERM
209
210The current terminal. Whenever a callback/Hook is bein executed, this
211variable stores the current C<urxvt::term> object.
212
213=back
214
176=head2 Functions in the C<urxvt> Package 215=head2 Functions in the C<urxvt> Package
177 216
178=over 4 217=over 4
179 218
180=item urxvt::fatal $errormessage 219=item urxvt::fatal $errormessage
194 233
195=item $time = urxvt::NOW 234=item $time = urxvt::NOW
196 235
197Returns the "current time" (as per the event loop). 236Returns the "current time" (as per the event loop).
198 237
238=back
239
240=head2 RENDITION
241
242Rendition bitsets contain information about colour, font, font styles and
243similar information for each screen cell.
244
245The following "macros" deal with changes in rendition sets. You should
246never just create a bitset, you should always modify an existing one,
247as they contain important information required for correct operation of
248rxvt-unicode.
249
250=over 4
251
252=item $rend = urxvt::DEFAULT_RSTYLE
253
254Returns the default rendition, as used when the terminal is starting up or
255being reset. Useful as a base to start when creating renditions.
256
257=item $rend = urxvt::OVERLAY_RSTYLE
258
259Return the rendition mask used for overlays by default.
260
261=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
262
263Return the bit that enabled bold, italic, blink, reverse-video and
264underline, respectively. To enable such a style, just logically OR it into
265the bitset.
266
267=item $foreground = urxvt::GET_BASEFG $rend
268
269=item $background = urxvt::GET_BASEBG $rend
270
271Return the foreground/background colour index, respectively.
272
273=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
274
275=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
276
277Replace the foreground/background colour in the rendition mask with the
278specified one.
279
280=item $value = urxvt::GET_CUSTOM ($rend)
281
282Return the "custom" value: Every rendition has 5 bits for use by
283extensions. They can be set and changed as you like and are initially
284zero.
285
286=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
287
288Change the custom value.
289
290=back
291
199=cut 292=cut
200 293
201package urxvt; 294package urxvt;
202 295
203use strict; 296use strict;
297use Scalar::Util ();
204 298
205our $term; 299our $TERM;
206our @HOOKNAME; 300our @HOOKNAME;
207our $LIBDIR; 301our $LIBDIR;
208 302
209BEGIN { 303BEGIN {
210 urxvt->bootstrap; 304 urxvt->bootstrap;
235 my $name = $HOOKNAME[$htype]; 329 my $name = $HOOKNAME[$htype];
236 330
237 my $ref = $pkg->can ("on_" . lc $name) 331 my $ref = $pkg->can ("on_" . lc $name)
238 or next; 332 or next;
239 333
240 $term->{_hook}[$htype]{$ref*1} = $ref; 334 $TERM->{_hook}[$htype]{$pkg} = $ref;
241 $hook_count[$htype]++ 335 $hook_count[$htype]++
242 or set_should_invoke $htype, 1; 336 or set_should_invoke $htype, 1;
243 } 337 }
244} 338}
245 339
269 } 363 }
270} 364}
271 365
272# called by the rxvt core 366# called by the rxvt core
273sub invoke { 367sub invoke {
274 local $term = shift; 368 local $TERM = shift;
275 my $htype = shift; 369 my $htype = shift;
276 370
277 if ($htype == 0) { # INIT 371 if ($htype == 0) { # INIT
278 my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl"); 372 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
279 373
280 for my $ext (split /:/, $term->resource ("perl_ext")) { 374 for my $ext (split /:/, $TERM->resource ("perl_ext")) {
281 my @files = grep -f $_, map "$_/$ext", @dirs; 375 my @files = grep -f $_, map "$_/$ext", @dirs;
282 376
283 if (@files) { 377 if (@files) {
284 register_package script_package $files[0]; 378 register_package script_package $files[0];
285 } else { 379 } else {
286 warn "perl extension '$ext' not found in perl library search path\n"; 380 warn "perl extension '$ext' not found in perl library search path\n";
287 } 381 }
288 } 382 }
289 383
290 } elsif ($htype == 1) { # DESTROY 384 } elsif ($htype == 1) { # DESTROY
291 if (my $hook = $term->{_hook}) { 385 if (my $hook = $TERM->{_hook}) {
292 for my $htype (0..$#$hook) { 386 for my $htype (0..$#$hook) {
293 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } 387 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
294 or set_should_invoke $htype, 0; 388 or set_should_invoke $htype, 0;
295 } 389 }
296 } 390 }
297 } 391 }
298 392
299 my $cb = $term->{_hook}[$htype] 393 my $cb = $TERM->{_hook}[$htype]
300 or return; 394 or return;
301 395
302 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")" 396 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
303 if $verbosity >= 10; 397 if $verbosity >= 10;
304 398
399 keys %$cb;
400
305 while (my ($k, $v) = each %$cb) { 401 while (my ($pkg, $cb) = each %$cb) {
306 return 1 if $v->($term, @_); 402 return 1
403 if $cb->(
404 $TERM->{$pkg} ||= do {
405 my $proxy = bless { }, urxvt::term::proxy::;
406 Scalar::Util::weaken ($proxy->{term} = $TERM);
407 $proxy
408 },
409 @_,
410 );
307 } 411 }
308 412
309 0 413 0
310} 414}
311 415
312=back 416sub urxvt::term::proxy::AUTOLOAD {
417 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
418 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
419
420 eval qq{
421 sub $urxvt::term::proxy::AUTOLOAD {
422 my \$proxy = shift;
423 \$proxy->{term}->$1 (\@_)
424 }
425 1
426 } or die "FATAL: unable to compile method forwarder: $@";
427
428 goto &$urxvt::term::proxy::AUTOLOAD;
429}
313 430
314=head2 The C<urxvt::term> Class 431=head2 The C<urxvt::term> Class
315 432
316=over 4 433=over 4
317 434
373 490
374=item $oldtext = $term->selection ([$newtext]) 491=item $oldtext = $term->selection ([$newtext])
375 492
376Return the current selection text and optionally replace it by C<$newtext>. 493Return the current selection text and optionally replace it by C<$newtext>.
377 494
378=item $term->scr_overlay ($x, $y, $text) 495#=item $term->overlay ($x, $y, $text)
379 496#
380Create a simple multi-line overlay box. See the next method for details. 497#Create a simple multi-line overlay box. See the next method for details.
381 498#
382=cut 499#=cut
383 500
384sub urxvt::term::scr_overlay { 501sub urxvt::term::scr_overlay {
502die;
385 my ($self, $x, $y, $text) = @_; 503 my ($self, $x, $y, $text) = @_;
386 504
387 my @lines = split /\n/, $text; 505 my @lines = split /\n/, $text;
388 506
389 my $w = 0; 507 my $w = 0;
393 511
394 $self->scr_overlay_new ($x, $y, $w, scalar @lines); 512 $self->scr_overlay_new ($x, $y, $w, scalar @lines);
395 $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; 513 $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
396} 514}
397 515
398=item $term->scr_overlay_new ($x, $y, $width, $height) 516=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
399 517
400Create a new (empty) overlay at the given position with the given 518Create a new (empty) overlay at the given position with the given
401width/height. A border will be put around the box. If either C<$x> or 519width/height. C<$rstyle> defines the initial rendition style
402C<$y> is negative, then this is counted from the right/bottom side, 520(default: C<OVERLAY_RSTYLE>).
403respectively.
404 521
405=item $term->scr_overlay_off 522If C<$border> is C<2> (default), then a decorative border will be put
523around the box.
406 524
407Switch the overlay off again. 525If either C<$x> or C<$y> is negative, then this is counted from the
526right/bottom side, respectively.
408 527
409=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE) 528This method returns an urxvt::overlay object. The overlay will be visible
529as long as the perl object is referenced.
410 530
411Put a single character (specified numerically) at the given overlay 531The methods currently supported on C<urxvt::overlay> objects are:
412position.
413 532
533=over 4
534
414=item $term->scr_overlay_set ($x, $y, $text) 535=item $overlay->set ($x, $y, $text, $rend)
415 536
416Write a string at the given position into the overlay. 537Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
538text in rxvt-unicode's special encoding and an array of rendition values
539at a specific position inside the overlay.
540
541=item $overlay->hide
542
543If visible, hide the overlay, but do not destroy it.
544
545=item $overlay->show
546
547If hidden, display the overlay again.
548
549=back
417 550
418=item $cellwidth = $term->strwidth $string 551=item $cellwidth = $term->strwidth $string
419 552
420Returns the number of screen-cells this string would need. Correctly 553Returns the number of screen-cells this string would need. Correctly
421accounts for wide and combining characters. 554accounts for wide and combining characters.
462=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 595=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
463 596
464Returns the text of the entire row with number C<$row_number>. Row C<0> 597Returns the text of the entire row with number C<$row_number>. Row C<0>
465is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 598is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
466terminal line. The scrollback buffer starts at line C<-1> and extends to 599terminal line. The scrollback buffer starts at line C<-1> and extends to
467line C<< -$term->nsaved >>. 600line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
601is requested.
468 602
469If C<$new_text> is specified, it will replace characters in the current 603If C<$new_text> is specified, it will replace characters in the current
470line, starting at column C<$start_col> (default C<0>), which is useful 604line, starting at column C<$start_col> (default C<0>), which is useful
471to replace only parts of a line. The font iindex in the rendition will 605to replace only parts of a line. The font index in the rendition will
472automatically be updated. 606automatically be updated.
473 607
474C<$text> is in a special encoding: tabs and wide characters that use more 608C<$text> is in a special encoding: tabs and wide characters that use more
475than one cell when displayed are padded with urxvt::NOCHAR characters 609than one cell when displayed are padded with urxvt::NOCHAR characters
476(C<chr 65535>). Characters with combining characters and other characters 610(C<chr 65535>). Characters with combining characters and other characters
490bitsets. Rendition bitsets contain information about colour, font, font 624bitsets. Rendition bitsets contain information about colour, font, font
491styles and similar information. See also C<< $term->ROW_t >>. 625styles and similar information. See also C<< $term->ROW_t >>.
492 626
493When setting rendition, the font mask will be ignored. 627When setting rendition, the font mask will be ignored.
494 628
495See the section on RENDITION, below. 629See the section on RENDITION, above.
496 630
497=item $length = $term->ROW_l ($row_number[, $new_length]) 631=item $length = $term->ROW_l ($row_number[, $new_length])
498 632
499Returns the number of screen cells that are in use ("the line length"). If 633Returns the number of screen cells that are in use ("the line
500it is C<-1>, then the line is part of a multiple-row logical "line", which 634length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
501means all characters are in use and it is continued on the next row. 635line is joined with the following one.
502 636
637=item $bool = $term->is_longer ($row_number)
638
639Returns true if the row is part of a multiple-row logical "line" (i.e.
640joined with the following row), which means all characters are in use
641and it is continued on the next row (and possibly a continuation of the
642previous row(s)).
643
644=item $line = $term->line ($row_number)
645
646Create and return a new C<urxvt::line> object that stores information
647about the logical line that row C<$row_number> is part of. It supports the
648following methods:
649
650=over 4
651
652=item $text = $line->t
653
654Returns the full text of the line, similar to C<ROW_t>
655
656=item $rend = $line->r
657
658Returns the full rendition array of the line, similar to C<ROW_r>
659
660=item $length = $line->l
661
662Returns the length of the line in cells, similar to C<ROW_l>.
663
664=item $rownum = $line->beg
665
666=item $rownum = $line->end
667
668Return the row number of the first/last row of the line, respectively.
669
670=item $offset = $line->offset_of ($row, $col)
671
672Returns the character offset of the given row|col pair within the logical
673line.
674
675=item ($row, $col) = $line->coord_of ($offset)
676
677Translates a string offset into terminal coordinates again.
678
679=back
680
681=cut
682
683sub urxvt::term::line {
684 my ($self, $row) = @_;
685
686 my $maxrow = $self->nrow - 1;
687
688 my ($beg, $end) = ($row, $row);
689
690 --$beg while $self->ROW_is_longer ($beg - 1);
691 ++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
692
693 bless {
694 term => $self,
695 beg => $beg,
696 end => $end,
697 len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
698 }, urxvt::line::
699}
700
701sub urxvt::line::t {
702 my ($self) = @_;
703
704 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
705 0, $self->{len}
706}
707
708sub urxvt::line::r {
709 my ($self) = @_;
710
711 my $rend = [
712 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
713 ];
714 $#$rend = $self->{len} - 1;
715 $rend
716}
717
718sub urxvt::line::beg { $_[0]{beg} }
719sub urxvt::line::end { $_[0]{end} }
720sub urxvt::line::l { $_[0]{len} }
721
722sub urxvt::line::offset_of {
723 my ($self, $row, $col) = @_;
724
725 ($row - $self->{beg}) * $self->{term}->ncol + $col
726}
727
728sub urxvt::line::coord_of {
729 my ($self, $offset) = @_;
730
731 use integer;
732
733 (
734 $offset / $self->{term}->ncol + $self->{beg},
735 $offset % $self->{term}->ncol
736 )
737}
738
739=item ($row, $col) = $line->coord_of ($offset)
503=item $text = $term->special_encode $string 740=item $text = $term->special_encode $string
504 741
505Converts a perl string into the special encoding used by rxvt-unicode, 742Converts a perl string into the special encoding used by rxvt-unicode,
506where one character corresponds to one screen cell. See 743where one character corresponds to one screen cell. See
507C<< $term->ROW_t >> for details. 744C<< $term->ROW_t >> for details.
511Converts rxvt-unicodes text reprsentation into a perl string. See 748Converts rxvt-unicodes text reprsentation into a perl string. See
512C<< $term->ROW_t >> for details. 749C<< $term->ROW_t >> for details.
513 750
514=back 751=back
515 752
516=head2 RENDITION
517
518Rendition bitsets contain information about colour, font, font styles and
519similar information for each screen cell.
520
521The following "macros" deal with changes in rendition sets. You should
522never just create a bitset, you should always modify an existing one,
523as they contain important information required for correct operation of
524rxvt-unicode.
525
526=over 4
527
528=item $rend = urxvt::DEFAULT_RSTYLE
529
530Returns the default rendition, as used when the terminal is starting up or
531being reset. Useful as a base
532
533=back
534
535=cut
536
537=head2 The C<urxvt::timer> Class 753=head2 The C<urxvt::timer> Class
538 754
539This class implements timer watchers/events. Time is represented as a 755This class implements timer watchers/events. Time is represented as a
540fractional number of seconds since the epoch. Example: 756fractional number of seconds since the epoch. Example:
541 757
542 # create a digital clock display in upper right corner 758 $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
543 $term->{timer} = urxvt::timer 759 $term->{timer} = urxvt::timer
544 ->new 760 ->new
545 ->start (urxvt::NOW) 761 ->interval (1)
546 ->cb (sub { 762 ->cb (sub {
547 my ($timer) = @_;
548 my $time = $timer->at;
549 $timer->start ($time + 1);
550 $self->scr_overlay (-1, 0, 763 $term->{overlay}->set (0, 0,
551 POSIX::strftime "%H:%M:%S", localtime $time); 764 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
552 }); 765 });
553 766
554=over 4 767=over 4
555 768
556=item $timer = new urxvt::timer 769=item $timer = new urxvt::timer
557 770
558Create a new timer object in stopped state. 771Create a new timer object in started state. It is scheduled to fire
772immediately.
559 773
560=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 774=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
561 775
562Set the callback to be called when the timer triggers. 776Set the callback to be called when the timer triggers.
563 777
566Return the time this watcher will fire next. 780Return the time this watcher will fire next.
567 781
568=item $timer = $timer->set ($tstamp) 782=item $timer = $timer->set ($tstamp)
569 783
570Set the time the event is generated to $tstamp. 784Set the time the event is generated to $tstamp.
785
786=item $timer = $timer->interval ($interval)
787
788Normally (and when C<$interval> is C<0>), the timer will automatically
789stop after it has fired once. If C<$interval> is non-zero, then the timer
790is automatically rescheduled at the given intervals.
571 791
572=item $timer = $timer->start 792=item $timer = $timer->start
573 793
574Start the timer. 794Start the timer.
575 795
638This variable controls the verbosity level of the perl extension. Higher 858This variable controls the verbosity level of the perl extension. Higher
639numbers indicate more verbose output. 859numbers indicate more verbose output.
640 860
641=over 4 861=over 4
642 862
643=item 0 - only fatal messages 863=item =0 - only fatal messages
644 864
645=item 3 - script loading and management 865=item =3 - script loading and management
646 866
647=item 10 - all events received 867=item =10 - all events received
648 868
649=back 869=back
650 870
651=head1 AUTHOR 871=head1 AUTHOR
652 872

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines