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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines