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.11 by root, Mon Jan 2 21:41:51 2006 UTC vs.
Revision 1.25 by root, Tue Jan 3 21:08:39 2006 UTC

1=encoding utf8
2
1=head1 NAME 3=head1 NAME
2 4
3@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter 5@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter
4 6
5=head1 SYNOPSIS 7=head1 SYNOPSIS
22 24
23Scripts are compiled in a 'use strict' and 'use utf8' environment, and 25Scripts are compiled in a 'use strict' and 'use utf8' environment, and
24thus must be encoded as UTF-8. 26thus must be encoded as UTF-8.
25 27
26Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where 28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
27scripts will be shared (But not enabled) for all terminals. 29scripts will be shared (but not enabled) for all terminals.
30
31=head2 Prepackaged Extensions
32
33This section describes the extensiosn delivered with this version. You can
34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35
36You can activate them like this:
37
38 @@RXVT_NAME@@ -pe <extensionname>
39
40=over 4
41
42=item selection
43
44Intelligent selection. This etxension tries to be more intelligent when the user
45extends selections (double-click).
46
47It also offers the following bindable event:
48
49=over 4
50
51=item rot13
52
53Rot-13 the selection when activated. Used via keyboard trigger:
54
55 URxvt.keysym.C-M-r: perl:selection:rot13
56
57=back
58
59=item digital-clock
60
61Displays a digital clock using the built-in overlay.
62
63=item example-refresh-hooks
64
65Displays a very simple digital clock in the upper right corner of the
66window. Illustrates overwriting the refresh callbacks to create your own
67overlays or changes.
68
69=back
28 70
29=head2 General API Considerations 71=head2 General API Considerations
30 72
31All objects (such as terminals, time watchers etc.) are typical 73All objects (such as terminals, time watchers etc.) are typical
32reference-to-hash objects. The hash can be used to store anything you 74reference-to-hash objects. The hash can be used to store anything you
33like. All members starting with an underscore (such as C<_ptr> or 75like. All members starting with an underscore (such as C<_ptr> or
34C<_hook>) are reserved for internal uses and must not be accessed or 76C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
35modified). 77modified).
36 78
37When objects are destroyed on the C++ side, the perl object hashes are 79When objects are destroyed on the C++ side, the perl object hashes are
38emptied, so its best to store related objects such as time watchers and 80emptied, so its best to store related objects such as time watchers and
39the like inside the terminal object so they get destroyed as soon as the 81the like inside the terminal object so they get destroyed as soon as the
40terminal is destroyed. 82terminal is destroyed.
41 83
42=head2 Hooks 84=head2 Hooks
43 85
44The following subroutines can be declared in loaded scripts, and will be called 86The following subroutines can be declared in loaded scripts, and will be
45whenever the relevant event happens. 87called whenever the relevant event happens.
88
89The first argument passed to them is an object private to each terminal
90and extension package. You can call all C<urxvt::term> methods on it, but
91its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
92object that is shared between all packages is stored in the C<term>
93member.
46 94
47All of them must return a boolean value. If it is true, then the event 95All of them must return a boolean value. If it is true, then the event
48counts as being I<consumed>, and the invocation of other hooks is skipped, 96counts as being I<consumed>, and the invocation of other hooks is skipped,
49and the relevant action might not be carried out by the C++ code. 97and the relevant action might not be carried out by the C++ code.
50 98
82Called whenever a selection has been copied, but before the selection is 130Called whenever a selection has been copied, but before the selection is
83requested from the server. The selection text can be queried and changed 131requested from the server. The selection text can be queried and changed
84by calling C<< $term->selection >>. 132by calling C<< $term->selection >>.
85 133
86Returning a true value aborts selection grabbing. It will still be hilighted. 134Returning a true value aborts selection grabbing. It will still be hilighted.
135
136=item on_sel_extend $term
137
138Called whenever the user tries to extend the selection (e.g. with a double
139click) and is either supposed to return false (normal operation), or
140should extend the selection itelf and return true to suppress the built-in
141processing.
142
143See the F<selection> example extension.
87 144
88=item on_focus_in $term 145=item on_focus_in $term
89 146
90Called whenever the window gets the keyboard focus, before urxvt does 147Called whenever the window gets the keyboard focus, before urxvt does
91focus in processing. 148focus in processing.
132C<perl:string> action bound to it (see description of the B<keysym> 189C<perl:string> action bound to it (see description of the B<keysym>
133resource in the @@RXVT_NAME@@(1) manpage). 190resource in the @@RXVT_NAME@@(1) manpage).
134 191
135=back 192=back
136 193
194=head2 Variables in the C<urxvt> Package
195
196=over 4
197
198=item $urxvt::TERM
199
200The current terminal. Whenever a callback/Hook is bein executed, this
201variable stores the current C<urxvt::term> object.
202
203=back
204
137=head2 Functions in the C<urxvt> Package 205=head2 Functions in the C<urxvt> Package
138 206
139=over 4 207=over 4
140 208
141=item urxvt::fatal $errormessage 209=item urxvt::fatal $errormessage
155 223
156=item $time = urxvt::NOW 224=item $time = urxvt::NOW
157 225
158Returns the "current time" (as per the event loop). 226Returns the "current time" (as per the event loop).
159 227
228=back
229
230=head2 RENDITION
231
232Rendition bitsets contain information about colour, font, font styles and
233similar information for each screen cell.
234
235The following "macros" deal with changes in rendition sets. You should
236never just create a bitset, you should always modify an existing one,
237as they contain important information required for correct operation of
238rxvt-unicode.
239
240=over 4
241
242=item $rend = urxvt::DEFAULT_RSTYLE
243
244Returns the default rendition, as used when the terminal is starting up or
245being reset. Useful as a base to start when creating renditions.
246
247=item $rend = urxvt::OVERLAY_RSTYLE
248
249Return the rendition mask used for overlays by default.
250
251=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
252
253Return the bit that enabled bold, italic, blink, reverse-video and
254underline, respectively. To enable such a style, just logically OR it into
255the bitset.
256
257=item $foreground = urxvt::GET_BASEFG $rend
258
259=item $background = urxvt::GET_BASEBG $rend
260
261Return the foreground/background colour index, respectively.
262
263=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
264
265=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
266
267Replace the foreground/background colour in the rendition mask with the
268specified one.
269
270=item $value = urxvt::GET_CUSTOM ($rend)
271
272Return the "custom" value: Every rendition has 5 bits for use by
273extensions. They can be set and changed as you like and are initially
274zero.
275
276=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
277
278Change the custom value.
279
280=back
281
160=cut 282=cut
161 283
162package urxvt; 284package urxvt;
163 285
164use strict; 286use strict;
287use Scalar::Util ();
165 288
166our $term; 289our $TERM;
167our @HOOKNAME; 290our @HOOKNAME;
168our $LIBDIR; 291our $LIBDIR;
169 292
170BEGIN { 293BEGIN {
171 urxvt->bootstrap; 294 urxvt->bootstrap;
196 my $name = $HOOKNAME[$htype]; 319 my $name = $HOOKNAME[$htype];
197 320
198 my $ref = $pkg->can ("on_" . lc $name) 321 my $ref = $pkg->can ("on_" . lc $name)
199 or next; 322 or next;
200 323
201 $term->{_hook}[$htype]{$ref*1} = $ref; 324 $TERM->{_hook}[$htype]{$pkg} = $ref;
202 $hook_count[$htype]++ 325 $hook_count[$htype]++
203 or set_should_invoke $htype, 1; 326 or set_should_invoke $htype, 1;
204 } 327 }
205} 328}
206 329
230 } 353 }
231} 354}
232 355
233# called by the rxvt core 356# called by the rxvt core
234sub invoke { 357sub invoke {
235 local $term = shift; 358 local $TERM = shift;
236 my $htype = shift; 359 my $htype = shift;
237 360
238 if ($htype == 0) { # INIT 361 if ($htype == 0) { # INIT
239 my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl"); 362 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
240 363
241 for my $ext (split /:/, $term->resource ("perl_ext")) { 364 for my $ext (split /:/, $TERM->resource ("perl_ext")) {
242 my @files = grep -f $_, map "$_/$ext", @dirs; 365 my @files = grep -f $_, map "$_/$ext", @dirs;
243 366
244 if (@files) { 367 if (@files) {
245 register_package script_package $files[0]; 368 register_package script_package $files[0];
246 } else { 369 } else {
247 warn "perl extension '$ext' not found in perl library search path\n"; 370 warn "perl extension '$ext' not found in perl library search path\n";
248 } 371 }
249 } 372 }
250 373
251 } elsif ($htype == 1) { # DESTROY 374 } elsif ($htype == 1) { # DESTROY
252 if (my $hook = $term->{_hook}) { 375 if (my $hook = $TERM->{_hook}) {
253 for my $htype (0..$#$hook) { 376 for my $htype (0..$#$hook) {
254 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } 377 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
255 or set_should_invoke $htype, 0; 378 or set_should_invoke $htype, 0;
256 } 379 }
257 } 380 }
258 } 381 }
259 382
260 my $cb = $term->{_hook}[$htype] 383 my $cb = $TERM->{_hook}[$htype]
261 or return; 384 or return;
262 385
263 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")" 386 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
264 if $verbosity >= 10; 387 if $verbosity >= 10;
265 388
389 keys %$cb;
390
266 while (my ($k, $v) = each %$cb) { 391 while (my ($pkg, $cb) = each %$cb) {
267 return 1 if $v->($term, @_); 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 );
268 } 401 }
269 402
270 0 403 0
271} 404}
272 405
273=back 406sub urxvt::term::proxy::AUTOLOAD {
407 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
408 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
409
410 eval qq{
411 sub $urxvt::term::proxy::AUTOLOAD {
412 my \$proxy = shift;
413 \$proxy->{term}->$1 (\@_)
414 }
415 1
416 } or die "FATAL: unable to compile method forwarder: $@";
417
418 goto &$urxvt::term::proxy::AUTOLOAD;
419}
274 420
275=head2 The C<urxvt::term> Class 421=head2 The C<urxvt::term> Class
276 422
277=over 4 423=over 4
278 424
334 480
335=item $oldtext = $term->selection ([$newtext]) 481=item $oldtext = $term->selection ([$newtext])
336 482
337Return the current selection text and optionally replace it by C<$newtext>. 483Return the current selection text and optionally replace it by C<$newtext>.
338 484
339=item $term->scr_overlay ($x, $y, $text) 485#=item $term->overlay ($x, $y, $text)
340 486#
341Create a simple multi-line overlay box. See the next method for details. 487#Create a simple multi-line overlay box. See the next method for details.
342 488#
343=cut 489#=cut
344 490
345sub urxvt::term::scr_overlay { 491sub urxvt::term::scr_overlay {
492die;
346 my ($self, $x, $y, $text) = @_; 493 my ($self, $x, $y, $text) = @_;
347 494
348 my @lines = split /\n/, $text; 495 my @lines = split /\n/, $text;
349 496
350 my $w = 0; 497 my $w = 0;
354 501
355 $self->scr_overlay_new ($x, $y, $w, scalar @lines); 502 $self->scr_overlay_new ($x, $y, $w, scalar @lines);
356 $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; 503 $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
357} 504}
358 505
359=item $term->scr_overlay_new ($x, $y, $width, $height) 506=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
360 507
361Create a new (empty) overlay at the given position with the given 508Create a new (empty) overlay at the given position with the given
362width/height. A border will be put around the box. If either C<$x> or 509width/height. C<$rstyle> defines the initial rendition style
363C<$y> is negative, then this is counted from the right/bottom side, 510(default: C<OVERLAY_RSTYLE>).
364respectively.
365 511
366=item $term->scr_overlay_off 512If C<$border> is C<2> (default), then a decorative border will be put
513around the box.
367 514
368Switch the overlay off again. 515If either C<$x> or C<$y> is negative, then this is counted from the
516right/bottom side, respectively.
369 517
370=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE) 518This method returns an urxvt::overlay object. The overlay will be visible
519as long as the perl object is referenced.
371 520
372Put a single character (specified numerically) at the given overlay 521The methods currently supported on C<urxvt::overlay> objects are:
373position.
374 522
523=over 4
524
375=item $term->scr_overlay_set ($x, $y, $text) 525=item $overlay->set ($x, $y, $text, $rend)
376 526
377Write a string at the given position into the overlay. 527Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
528text in rxvt-unicode's special encoding and an array of rendition values
529at a specific position inside the overlay.
530
531=item $overlay->hide
532
533If visible, hide the overlay, but do not destroy it.
534
535=item $overlay->show
536
537If hidden, display the overlay again.
538
539=back
378 540
379=item $cellwidth = $term->strwidth $string 541=item $cellwidth = $term->strwidth $string
380 542
381Returns the number of screen-cells this string would need. Correctly 543Returns the number of screen-cells this string would need. Correctly
382accounts for wide and combining characters. 544accounts for wide and combining characters.
390Convert the given locale-encoded octets into a perl string. 552Convert the given locale-encoded octets into a perl string.
391 553
392=item $term->tt_write ($octets) 554=item $term->tt_write ($octets)
393 555
394Write the octets given in C<$data> to the tty (i.e. as program input). To 556Write the octets given in C<$data> to the tty (i.e. as program input). To
395pass characters instead of octets, you should convetr you strings first to 557pass characters instead of octets, you should convert your strings first
396the locale-specific encoding using C<< $term->locale_encode >>. 558to the locale-specific encoding using C<< $term->locale_encode >>.
559
560=item $nrow = $term->nrow
561
562=item $ncol = $term->ncol
563
564Return the number of rows/columns of the terminal window (i.e. as
565specified by C<-geometry>, excluding any scrollback).
566
567=item $nsaved = $term->nsaved
568
569Returns the number of lines in the scrollback buffer.
570
571=item $view_start = $term->view_start ([$newvalue])
572
573Returns the negative row number of the topmost line. Minimum value is
574C<0>, which displays the normal terminal contents. Larger values scroll
575this many lines into the scrollback buffer.
576
577=item $term->want_refresh
578
579Requests a screen refresh. At the next opportunity, rxvt-unicode will
580compare the on-screen display with its stored representation. If they
581differ, it redraws the differences.
582
583Used after changing terminal contents to display them.
584
585=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
586
587Returns the text of the entire row with number C<$row_number>. Row C<0>
588is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
589terminal line. The scrollback buffer starts at line C<-1> and extends to
590line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
591is requested.
592
593If C<$new_text> is specified, it will replace characters in the current
594line, starting at column C<$start_col> (default C<0>), which is useful
595to replace only parts of a line. The font index in the rendition will
596automatically be updated.
597
598C<$text> is in a special encoding: tabs and wide characters that use more
599than one cell when displayed are padded with urxvt::NOCHAR characters
600(C<chr 65535>). Characters with combining characters and other characters
601that do not fit into the normal tetx encoding will be replaced with
602characters in the private use area.
603
604You have to obey this encoding when changing text. The advantage is
605that C<substr> and similar functions work on screen cells and not on
606characters.
607
608The methods C<< $term->special_encode >> and C<< $term->special_decode >>
609can be used to convert normal strings into this encoding and vice versa.
610
611=item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
612
613Like C<< $term->ROW_t >>, but returns an arrayref with rendition
614bitsets. Rendition bitsets contain information about colour, font, font
615styles and similar information. See also C<< $term->ROW_t >>.
616
617When setting rendition, the font mask will be ignored.
618
619See the section on RENDITION, above.
620
621=item $length = $term->ROW_l ($row_number[, $new_length])
622
623Returns the number of screen cells that are in use ("the line
624length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
625line is joined with the following one.
626
627=item $bool = $term->is_longer ($row_number)
628
629Returns true if the row is part of a multiple-row logical "line" (i.e.
630joined with the following row), which means all characters are in use
631and it is continued on the next row (and possibly a continuation of the
632previous row(s)).
633
634=item $line = $term->line ($row_number)
635
636Create and return a new C<urxvt::line> object that stores information
637about the logical line that row C<$row_number> is part of. It supports the
638following methods:
639
640=over 4
641
642=item $text = $line->t
643
644Returns the full text of the line, similar to C<ROW_t>
645
646=item $rend = $line->r
647
648Returns the full rendition array of the line, similar to C<ROW_r>
649
650=item $length = $line->l
651
652Returns the length of the line in cells, similar to C<ROW_l>.
653
654=item $rownum = $line->beg
655
656=item $rownum = $line->end
657
658Return the row number of the first/last row of the line, respectively.
659
660=item $offset = $line->offset_of ($row, $col)
661
662Returns the character offset of the given row|col pair within the logical
663line.
664
665=item ($row, $col) = $line->coord_of ($offset)
666
667Translates a string offset into terminal coordinates again.
668
669=back
670
671=cut
672
673sub urxvt::term::line {
674 my ($self, $row) = @_;
675
676 my $maxrow = $self->nrow - 1;
677
678 my ($beg, $end) = ($row, $row);
679
680 --$beg while $self->ROW_is_longer ($beg - 1);
681 ++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
682
683 bless {
684 term => $self,
685 beg => $beg,
686 end => $end,
687 len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
688 }, urxvt::line::
689}
690
691sub urxvt::line::t {
692 my ($self) = @_;
693
694 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
695 0, $self->{len}
696}
697
698sub urxvt::line::r {
699 my ($self) = @_;
700
701 my $rend = [
702 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
703 ];
704 $#$rend = $self->{len} - 1;
705 $rend
706}
707
708sub urxvt::line::beg { $_[0]{beg} }
709sub urxvt::line::end { $_[0]{end} }
710sub urxvt::line::l { $_[0]{len} }
711
712sub urxvt::line::offset_of {
713 my ($self, $row, $col) = @_;
714
715 ($row - $self->{beg}) * $self->{term}->ncol + $col
716}
717
718sub urxvt::line::coord_of {
719 my ($self, $offset) = @_;
720
721 use integer;
722
723 (
724 $offset / $self->{term}->ncol + $self->{beg},
725 $offset % $self->{term}->ncol
726 )
727}
728
729=item ($row, $col) = $line->coord_of ($offset)
730=item $text = $term->special_encode $string
731
732Converts a perl string into the special encoding used by rxvt-unicode,
733where one character corresponds to one screen cell. See
734C<< $term->ROW_t >> for details.
735
736=item $string = $term->special_decode $text
737
738Converts rxvt-unicodes text reprsentation into a perl string. See
739C<< $term->ROW_t >> for details.
397 740
398=back 741=back
399 742
400=head2 The C<urxvt::timer> Class 743=head2 The C<urxvt::timer> Class
401 744
402This class implements timer watchers/events. Time is represented as a 745This class implements timer watchers/events. Time is represented as a
403fractional number of seconds since the epoch. Example: 746fractional number of seconds since the epoch. Example:
404 747
405 # create a digital clock display in upper right corner 748 $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
406 $term->{timer} = urxvt::timer 749 $term->{timer} = urxvt::timer
407 ->new 750 ->new
408 ->start (urxvt::NOW) 751 ->interval (1)
409 ->cb (sub { 752 ->cb (sub {
410 my ($timer) = @_;
411 my $time = $timer->at;
412 $timer->start ($time + 1);
413 $self->scr_overlay (-1, 0, 753 $term->{overlay}->set (0, 0,
414 POSIX::strftime "%H:%M:%S", localtime $time); 754 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
415 }); 755 });
416 756
417=over 4 757=over 4
418 758
419=item $timer = new urxvt::timer 759=item $timer = new urxvt::timer
420 760
421Create a new timer object in stopped state. 761Create a new timer object in started state. It is scheduled to fire
762immediately.
422 763
423=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 764=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
424 765
425Set the callback to be called when the timer triggers. 766Set the callback to be called when the timer triggers.
426 767
429Return the time this watcher will fire next. 770Return the time this watcher will fire next.
430 771
431=item $timer = $timer->set ($tstamp) 772=item $timer = $timer->set ($tstamp)
432 773
433Set the time the event is generated to $tstamp. 774Set the time the event is generated to $tstamp.
775
776=item $timer = $timer->interval ($interval)
777
778Normally (and when C<$interval> is C<0>), the timer will automatically
779stop after it has fired once. If C<$interval> is non-zero, then the timer
780is automatically rescheduled at the given intervals.
434 781
435=item $timer = $timer->start 782=item $timer = $timer->start
436 783
437Start the timer. 784Start the timer.
438 785

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines