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.9 by root, Mon Jan 2 20:40:20 2006 UTC vs.
Revision 1.24 by root, Tue Jan 3 20:47:36 2006 UTC

1=encoding utf8
2
1=head1 NAME 3=head1 NAME
2 4
3rxvtperl - rxvt-unicode's embedded perl interpreter 5@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter
4 6
5=head1 SYNOPSIS 7=head1 SYNOPSIS
6 8
7* Put your scripts into F<@@RXVT_LIBDIR@@/urxvt/perl/>, they will be loaded automatically. 9 # create a file grab_test in $HOME:
8
9* Scripts are evaluated in a 'use strict' and 'use utf8' environment, and
10thus must be encoded as UTF-8.
11 10
12 sub on_sel_grab { 11 sub on_sel_grab {
13 warn "you selected ", $_[0]->selection; 12 warn "you selected ", $_[0]->selection;
14 () 13 ()
15 } 14 }
16 15
17 1 16 # start a @@RXVT_NAME@@ using it:
17
18 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
18 19
19=head1 DESCRIPTION 20=head1 DESCRIPTION
20 21
21Everytime a terminal object gets created, scripts specified via the 22Everytime a terminal object gets created, scripts specified via the
22C<perl> resource are associated with it. 23C<perl> resource are loaded and associated with it.
24
25Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26thus must be encoded as UTF-8.
23 27
24Each 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
25scripts 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
26 70
27=head2 General API Considerations 71=head2 General API Considerations
28 72
29All objects (such as terminals, time watchers etc.) are typical 73All objects (such as terminals, time watchers etc.) are typical
30reference-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
31like. All members starting with an underscore (such as C<_ptr> or 75like. All members starting with an underscore (such as C<_ptr> or
32C<_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
33modified). 77modified).
34 78
35When 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
36emptied, 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
37the 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
38terminal is destroyed. 82terminal is destroyed.
39 83
40=head2 Hooks 84=head2 Hooks
41 85
42The following subroutines can be declared in loaded scripts, and will be called 86The following subroutines can be declared in loaded scripts, and will be
43whenever 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.
44 94
45All 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
46counts 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,
47and 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.
48 98
80Called whenever a selection has been copied, but before the selection is 130Called whenever a selection has been copied, but before the selection is
81requested from the server. The selection text can be queried and changed 131requested from the server. The selection text can be queried and changed
82by calling C<< $term->selection >>. 132by calling C<< $term->selection >>.
83 133
84Returning 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.
85 144
86=item on_focus_in $term 145=item on_focus_in $term
87 146
88Called whenever the window gets the keyboard focus, before urxvt does 147Called whenever the window gets the keyboard focus, before urxvt does
89focus in processing. 148focus in processing.
122 181
123=item on_refresh_end $term 182=item on_refresh_end $term
124 183
125Called just after the screen gets redrawn. See C<on_refresh_begin>. 184Called just after the screen gets redrawn. See C<on_refresh_begin>.
126 185
186=item on_keyboard_command $term, $string
187
188Called whenever the user presses a key combination that has a
189C<perl:string> action bound to it (see description of the B<keysym>
190resource in the @@RXVT_NAME@@(1) manpage).
191
192=back
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
127=back 203=back
128 204
129=head2 Functions in the C<urxvt> Package 205=head2 Functions in the C<urxvt> Package
130 206
131=over 4 207=over 4
147 223
148=item $time = urxvt::NOW 224=item $time = urxvt::NOW
149 225
150Returns the "current time" (as per the event loop). 226Returns the "current time" (as per the event loop).
151 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
152=cut 282=cut
153 283
154package urxvt; 284package urxvt;
155 285
156use strict; 286use strict;
287use Scalar::Util ();
157 288
158our $term; 289our $TERM;
159our @HOOKNAME; 290our @HOOKNAME;
160our $LIBDIR; 291our $LIBDIR;
161 292
162BEGIN { 293BEGIN {
163 urxvt->bootstrap; 294 urxvt->bootstrap;
188 my $name = $HOOKNAME[$htype]; 319 my $name = $HOOKNAME[$htype];
189 320
190 my $ref = $pkg->can ("on_" . lc $name) 321 my $ref = $pkg->can ("on_" . lc $name)
191 or next; 322 or next;
192 323
193 $term->{_hook}[$htype]{$ref*1} = $ref; 324 $TERM->{_hook}[$htype]{$pkg} = $ref;
194 $hook_count[$htype]++ 325 $hook_count[$htype]++
195 or set_should_invoke $htype, 1; 326 or set_should_invoke $htype, 1;
196 } 327 }
197} 328}
198 329
222 } 353 }
223} 354}
224 355
225# called by the rxvt core 356# called by the rxvt core
226sub invoke { 357sub invoke {
227 local $term = shift; 358 local $TERM = shift;
228 my $htype = shift; 359 my $htype = shift;
229 360
230 if ($htype == 0) { # INIT 361 if ($htype == 0) { # INIT
231 my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl"); 362 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
232 363
233 for my $ext (split /:/, $term->resource ("perl_ext")) { 364 for my $ext (split /:/, $TERM->resource ("perl_ext")) {
234 my @files = grep -f $_, map "$_/$ext", @dirs; 365 my @files = grep -f $_, map "$_/$ext", @dirs;
235 366
236 if (@files) { 367 if (@files) {
237 register_package script_package $files[0]; 368 register_package script_package $files[0];
238 } else { 369 } else {
239 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";
240 } 371 }
241 } 372 }
242 373
243 } elsif ($htype == 1) { # DESTROY 374 } elsif ($htype == 1) { # DESTROY
244 if (my $hook = $term->{_hook}) { 375 if (my $hook = $TERM->{_hook}) {
245 for my $htype (0..$#$hook) { 376 for my $htype (0..$#$hook) {
246 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } 377 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
247 or set_should_invoke $htype, 0; 378 or set_should_invoke $htype, 0;
248 } 379 }
249 } 380 }
250 } 381 }
251 382
252 my $cb = $term->{_hook}[$htype] 383 my $cb = $TERM->{_hook}[$htype]
253 or return; 384 or return;
254 385
255 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")" 386 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
256 if $verbosity >= 10; 387 if $verbosity >= 10;
257 388
258 while (my ($k, $v) = each %$cb) { 389 while (my ($pkg, $cb) = each %$cb) {
259 return 1 if $v->($term, @_); 390 return 1
391 if $cb->(
392 $TERM->{$pkg} ||= do {
393 my $proxy = bless { }, urxvt::term::proxy::;
394 Scalar::Util::weaken ($proxy->{term} = $TERM);
395 $proxy
396 },
397 @_,
398 );
260 } 399 }
261 400
262 0 401 0
263} 402}
264 403
265=back 404sub urxvt::term::proxy::AUTOLOAD {
405 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
406 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
407
408 eval qq{
409 sub $urxvt::term::proxy::AUTOLOAD {
410 my \$proxy = shift;
411 \$proxy->{term}->$1 (\@_)
412 }
413 1
414 } or die "FATAL: unable to compile method forwarder: $@";
415
416 goto &$urxvt::term::proxy::AUTOLOAD;
417}
266 418
267=head2 The C<urxvt::term> Class 419=head2 The C<urxvt::term> Class
268 420
269=over 4 421=over 4
270 422
326 478
327=item $oldtext = $term->selection ([$newtext]) 479=item $oldtext = $term->selection ([$newtext])
328 480
329Return the current selection text and optionally replace it by C<$newtext>. 481Return the current selection text and optionally replace it by C<$newtext>.
330 482
331=item $term->scr_overlay ($x, $y, $text) 483#=item $term->overlay ($x, $y, $text)
332 484#
333Create a simple multi-line overlay box. See the next method for details. 485#Create a simple multi-line overlay box. See the next method for details.
334 486#
335=cut 487#=cut
336 488
337sub urxvt::term::scr_overlay { 489sub urxvt::term::scr_overlay {
490die;
338 my ($self, $x, $y, $text) = @_; 491 my ($self, $x, $y, $text) = @_;
339 492
340 my @lines = split /\n/, $text; 493 my @lines = split /\n/, $text;
341 494
342 my $w = 0; 495 my $w = 0;
346 499
347 $self->scr_overlay_new ($x, $y, $w, scalar @lines); 500 $self->scr_overlay_new ($x, $y, $w, scalar @lines);
348 $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; 501 $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
349} 502}
350 503
351=item $term->scr_overlay_new ($x, $y, $width, $height) 504=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
352 505
353Create a new (empty) overlay at the given position with the given 506Create a new (empty) overlay at the given position with the given
354width/height. A border will be put around the box. If either C<$x> or 507width/height. C<$rstyle> defines the initial rendition style
355C<$y> is negative, then this is counted from the right/bottom side, 508(default: C<OVERLAY_RSTYLE>).
356respectively.
357 509
358=item $term->scr_overlay_off 510If C<$border> is C<2> (default), then a decorative border will be put
511around the box.
359 512
360Switch the overlay off again. 513If either C<$x> or C<$y> is negative, then this is counted from the
514right/bottom side, respectively.
361 515
362=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE) 516This method returns an urxvt::overlay object. The overlay will be visible
517as long as the perl object is referenced.
363 518
364Put a single character (specified numerically) at the given overlay 519The methods currently supported on C<urxvt::overlay> objects are:
365position.
366 520
521=over 4
522
367=item $term->scr_overlay_set ($x, $y, $text) 523=item $overlay->set ($x, $y, $text, $rend)
368 524
369Write a string at the given position into the overlay. 525Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
526text in rxvt-unicode's special encoding and an array of rendition values
527at a specific position inside the overlay.
528
529=item $overlay->hide
530
531If visible, hide the overlay, but do not destroy it.
532
533=item $overlay->show
534
535If hidden, display the overlay again.
536
537=back
370 538
371=item $cellwidth = $term->strwidth $string 539=item $cellwidth = $term->strwidth $string
372 540
373Returns the number of screen-cells this string would need. Correctly 541Returns the number of screen-cells this string would need. Correctly
374accounts for wide and combining characters. 542accounts for wide and combining characters.
382Convert the given locale-encoded octets into a perl string. 550Convert the given locale-encoded octets into a perl string.
383 551
384=item $term->tt_write ($octets) 552=item $term->tt_write ($octets)
385 553
386Write the octets given in C<$data> to the tty (i.e. as program input). To 554Write the octets given in C<$data> to the tty (i.e. as program input). To
387pass characters instead of octets, you should convetr you strings first to 555pass characters instead of octets, you should convert your strings first
388the locale-specific encoding using C<< $term->locale_encode >>. 556to the locale-specific encoding using C<< $term->locale_encode >>.
557
558=item $nrow = $term->nrow
559
560=item $ncol = $term->ncol
561
562Return the number of rows/columns of the terminal window (i.e. as
563specified by C<-geometry>, excluding any scrollback).
564
565=item $nsaved = $term->nsaved
566
567Returns the number of lines in the scrollback buffer.
568
569=item $view_start = $term->view_start ([$newvalue])
570
571Returns the negative row number of the topmost line. Minimum value is
572C<0>, which displays the normal terminal contents. Larger values scroll
573this many lines into the scrollback buffer.
574
575=item $term->want_refresh
576
577Requests a screen refresh. At the next opportunity, rxvt-unicode will
578compare the on-screen display with its stored representation. If they
579differ, it redraws the differences.
580
581Used after changing terminal contents to display them.
582
583=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
584
585Returns the text of the entire row with number C<$row_number>. Row C<0>
586is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
587terminal line. The scrollback buffer starts at line C<-1> and extends to
588line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
589is requested.
590
591If C<$new_text> is specified, it will replace characters in the current
592line, starting at column C<$start_col> (default C<0>), which is useful
593to replace only parts of a line. The font index in the rendition will
594automatically be updated.
595
596C<$text> is in a special encoding: tabs and wide characters that use more
597than one cell when displayed are padded with urxvt::NOCHAR characters
598(C<chr 65535>). Characters with combining characters and other characters
599that do not fit into the normal tetx encoding will be replaced with
600characters in the private use area.
601
602You have to obey this encoding when changing text. The advantage is
603that C<substr> and similar functions work on screen cells and not on
604characters.
605
606The methods C<< $term->special_encode >> and C<< $term->special_decode >>
607can be used to convert normal strings into this encoding and vice versa.
608
609=item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
610
611Like C<< $term->ROW_t >>, but returns an arrayref with rendition
612bitsets. Rendition bitsets contain information about colour, font, font
613styles and similar information. See also C<< $term->ROW_t >>.
614
615When setting rendition, the font mask will be ignored.
616
617See the section on RENDITION, above.
618
619=item $length = $term->ROW_l ($row_number[, $new_length])
620
621Returns the number of screen cells that are in use ("the line
622length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
623line is joined with the following one.
624
625=item $bool = $term->is_longer ($row_number)
626
627Returns true if the row is part of a multiple-row logical "line" (i.e.
628joined with the following row), which means all characters are in use
629and it is continued on the next row (and possibly a continuation of the
630previous row(s)).
631
632=item $line = $term->line ($row_number)
633
634Create and return a new C<urxvt::line> object that stores information
635about the logical line that row C<$row_number> is part of. It supports the
636following methods:
637
638=over 4
639
640=item $text = $line->t
641
642Returns the full text of the line, similar to C<ROW_t>
643
644=item $rend = $line->r
645
646Returns the full rendition array of the line, similar to C<ROW_r>
647
648=item $length = $line->l
649
650Returns the length of the line in cells, similar to C<ROW_l>.
651
652=item $rownum = $line->beg
653
654=item $rownum = $line->end
655
656Return the row number of the first/last row of the line, respectively.
657
658=item $offset = $line->offset_of ($row, $col)
659
660Returns the character offset of the given row|col pair within the logical
661line.
662
663=item ($row, $col) = $line->coord_of ($offset)
664
665Translates a string offset into terminal coordinates again.
666
667=back
668
669=cut
670
671sub urxvt::term::line {
672 my ($self, $row) = @_;
673
674 my $maxrow = $self->nrow - 1;
675
676 my ($beg, $end) = ($row, $row);
677
678 --$beg while $self->ROW_is_longer ($beg - 1);
679 ++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
680
681 bless {
682 term => $self,
683 beg => $beg,
684 end => $end,
685 len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
686 }, urxvt::line::
687}
688
689sub urxvt::line::t {
690 my ($self) = @_;
691
692 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
693 0, $self->{len}
694}
695
696sub urxvt::line::r {
697 my ($self) = @_;
698
699 my $rend = [
700 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
701 ];
702 $#$rend = $self->{len} - 1;
703 $rend
704}
705
706sub urxvt::line::beg { $_[0]{beg} }
707sub urxvt::line::end { $_[0]{end} }
708sub urxvt::line::l { $_[0]{len} }
709
710sub urxvt::line::offset_of {
711 my ($self, $row, $col) = @_;
712
713 ($row - $self->{beg}) * $self->{term}->ncol + $col
714}
715
716sub urxvt::line::coord_of {
717 my ($self, $offset) = @_;
718
719 use integer;
720
721 (
722 $offset / $self->{term}->ncol + $self->{beg},
723 $offset % $self->{term}->ncol
724 )
725}
726
727=item ($row, $col) = $line->coord_of ($offset)
728=item $text = $term->special_encode $string
729
730Converts a perl string into the special encoding used by rxvt-unicode,
731where one character corresponds to one screen cell. See
732C<< $term->ROW_t >> for details.
733
734=item $string = $term->special_decode $text
735
736Converts rxvt-unicodes text reprsentation into a perl string. See
737C<< $term->ROW_t >> for details.
389 738
390=back 739=back
391 740
392=head2 The C<urxvt::timer> Class 741=head2 The C<urxvt::timer> Class
393 742
394This class implements timer watchers/events. Time is represented as a 743This class implements timer watchers/events. Time is represented as a
395fractional number of seconds since the epoch. Example: 744fractional number of seconds since the epoch. Example:
396 745
397 # create a digital clock display in upper right corner 746 $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
398 $term->{timer} = urxvt::timer 747 $term->{timer} = urxvt::timer
399 ->new 748 ->new
400 ->start (urxvt::NOW) 749 ->interval (1)
401 ->cb (sub { 750 ->cb (sub {
402 my ($timer) = @_;
403 my $time = $timer->at;
404 $timer->start ($time + 1);
405 $self->scr_overlay (-1, 0, 751 $term->{overlay}->set (0, 0,
406 POSIX::strftime "%H:%M:%S", localtime $time); 752 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
407 }); 753 });
408 754
409=over 4 755=over 4
410 756
411=item $timer = new urxvt::timer 757=item $timer = new urxvt::timer
412 758
413Create a new timer object in stopped state. 759Create a new timer object in started state. It is scheduled to fire
760immediately.
414 761
415=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 762=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
416 763
417Set the callback to be called when the timer triggers. 764Set the callback to be called when the timer triggers.
418 765
421Return the time this watcher will fire next. 768Return the time this watcher will fire next.
422 769
423=item $timer = $timer->set ($tstamp) 770=item $timer = $timer->set ($tstamp)
424 771
425Set the time the event is generated to $tstamp. 772Set the time the event is generated to $tstamp.
773
774=item $timer = $timer->interval ($interval)
775
776Normally (and when C<$interval> is C<0>), the timer will automatically
777stop after it has fired once. If C<$interval> is non-zero, then the timer
778is automatically rescheduled at the given intervals.
426 779
427=item $timer = $timer->start 780=item $timer = $timer->start
428 781
429Start the timer. 782Start the timer.
430 783

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines