| … | |
… | |
| 71 | =head2 General API Considerations |
71 | =head2 General API Considerations |
| 72 | |
72 | |
| 73 | All objects (such as terminals, time watchers etc.) are typical |
73 | All objects (such as terminals, time watchers etc.) are typical |
| 74 | reference-to-hash objects. The hash can be used to store anything you |
74 | reference-to-hash objects. The hash can be used to store anything you |
| 75 | like. All members starting with an underscore (such as C<_ptr> or |
75 | like. All members starting with an underscore (such as C<_ptr> or |
| 76 | C<_hook>) are reserved for internal uses and must not be accessed or |
76 | C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or |
| 77 | modified). |
77 | modified). |
| 78 | |
78 | |
| 79 | When objects are destroyed on the C++ side, the perl object hashes are |
79 | When objects are destroyed on the C++ side, the perl object hashes are |
| 80 | emptied, so its best to store related objects such as time watchers and |
80 | emptied, so its best to store related objects such as time watchers and |
| 81 | the like inside the terminal object so they get destroyed as soon as the |
81 | the like inside the terminal object so they get destroyed as soon as the |
| 82 | terminal is destroyed. |
82 | terminal is destroyed. |
| 83 | |
83 | |
| 84 | =head2 Hooks |
84 | =head2 Hooks |
| 85 | |
85 | |
| 86 | The following subroutines can be declared in loaded scripts, and will be called |
86 | The following subroutines can be declared in loaded scripts, and will be |
| 87 | whenever the relevant event happens. |
87 | called whenever the relevant event happens. |
|
|
88 | |
|
|
89 | The first argument passed to them is an object private to each terminal |
|
|
90 | and extension package. You can call all C<urxvt::term> methods on it, but |
|
|
91 | its not a real C<urxvt::term> object. Instead, the real C<urxvt::term> |
|
|
92 | object that is shared between all packages is stored in the C<term> |
|
|
93 | member. |
| 88 | |
94 | |
| 89 | All of them must return a boolean value. If it is true, then the event |
95 | All of them must return a boolean value. If it is true, then the event |
| 90 | counts as being I<consumed>, and the invocation of other hooks is skipped, |
96 | counts as being I<consumed>, and the invocation of other hooks is skipped, |
| 91 | and the relevant action might not be carried out by the C++ code. |
97 | and the relevant action might not be carried out by the C++ code. |
| 92 | |
98 | |
| … | |
… | |
| 183 | C<perl:string> action bound to it (see description of the B<keysym> |
189 | C<perl:string> action bound to it (see description of the B<keysym> |
| 184 | resource in the @@RXVT_NAME@@(1) manpage). |
190 | resource in the @@RXVT_NAME@@(1) manpage). |
| 185 | |
191 | |
| 186 | =back |
192 | =back |
| 187 | |
193 | |
|
|
194 | =head2 Variables in the C<urxvt> Package |
|
|
195 | |
|
|
196 | =over 4 |
|
|
197 | |
|
|
198 | =item $urxvt::TERM |
|
|
199 | |
|
|
200 | The current terminal. Whenever a callback/Hook is bein executed, this |
|
|
201 | variable stores the current C<urxvt::term> object. |
|
|
202 | |
|
|
203 | =back |
|
|
204 | |
| 188 | =head2 Functions in the C<urxvt> Package |
205 | =head2 Functions in the C<urxvt> Package |
| 189 | |
206 | |
| 190 | =over 4 |
207 | =over 4 |
| 191 | |
208 | |
| 192 | =item urxvt::fatal $errormessage |
209 | =item urxvt::fatal $errormessage |
| … | |
… | |
| 265 | =cut |
282 | =cut |
| 266 | |
283 | |
| 267 | package urxvt; |
284 | package urxvt; |
| 268 | |
285 | |
| 269 | use strict; |
286 | use strict; |
|
|
287 | use Scalar::Util (); |
| 270 | |
288 | |
| 271 | our $term; |
289 | our $TERM; |
| 272 | our @HOOKNAME; |
290 | our @HOOKNAME; |
| 273 | our $LIBDIR; |
291 | our $LIBDIR; |
| 274 | |
292 | |
| 275 | BEGIN { |
293 | BEGIN { |
| 276 | urxvt->bootstrap; |
294 | urxvt->bootstrap; |
| … | |
… | |
| 301 | my $name = $HOOKNAME[$htype]; |
319 | my $name = $HOOKNAME[$htype]; |
| 302 | |
320 | |
| 303 | my $ref = $pkg->can ("on_" . lc $name) |
321 | my $ref = $pkg->can ("on_" . lc $name) |
| 304 | or next; |
322 | or next; |
| 305 | |
323 | |
| 306 | $term->{_hook}[$htype]{$ref*1} = $ref; |
324 | $TERM->{_hook}[$htype]{$pkg} = $ref; |
| 307 | $hook_count[$htype]++ |
325 | $hook_count[$htype]++ |
| 308 | or set_should_invoke $htype, 1; |
326 | or set_should_invoke $htype, 1; |
| 309 | } |
327 | } |
| 310 | } |
328 | } |
| 311 | |
329 | |
| … | |
… | |
| 335 | } |
353 | } |
| 336 | } |
354 | } |
| 337 | |
355 | |
| 338 | # called by the rxvt core |
356 | # called by the rxvt core |
| 339 | sub invoke { |
357 | sub invoke { |
| 340 | local $term = shift; |
358 | local $TERM = shift; |
| 341 | my $htype = shift; |
359 | my $htype = shift; |
| 342 | |
360 | |
| 343 | if ($htype == 0) { # INIT |
361 | if ($htype == 0) { # INIT |
| 344 | my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl"); |
362 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
| 345 | |
363 | |
| 346 | for my $ext (split /:/, $term->resource ("perl_ext")) { |
364 | for my $ext (split /:/, $TERM->resource ("perl_ext")) { |
| 347 | my @files = grep -f $_, map "$_/$ext", @dirs; |
365 | my @files = grep -f $_, map "$_/$ext", @dirs; |
| 348 | |
366 | |
| 349 | if (@files) { |
367 | if (@files) { |
| 350 | register_package script_package $files[0]; |
368 | register_package script_package $files[0]; |
| 351 | } else { |
369 | } else { |
| 352 | 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"; |
| 353 | } |
371 | } |
| 354 | } |
372 | } |
| 355 | |
373 | |
| 356 | } elsif ($htype == 1) { # DESTROY |
374 | } elsif ($htype == 1) { # DESTROY |
| 357 | if (my $hook = $term->{_hook}) { |
375 | if (my $hook = $TERM->{_hook}) { |
| 358 | for my $htype (0..$#$hook) { |
376 | for my $htype (0..$#$hook) { |
| 359 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
377 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
| 360 | or set_should_invoke $htype, 0; |
378 | or set_should_invoke $htype, 0; |
| 361 | } |
379 | } |
| 362 | } |
380 | } |
| 363 | } |
381 | } |
| 364 | |
382 | |
| 365 | my $cb = $term->{_hook}[$htype] |
383 | my $cb = $TERM->{_hook}[$htype] |
| 366 | or return; |
384 | or return; |
| 367 | |
385 | |
| 368 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")" |
386 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
| 369 | if $verbosity >= 10; |
387 | if $verbosity >= 10; |
| 370 | |
388 | |
| 371 | while (my ($k, $v) = each %$cb) { |
389 | while (my ($pkg, $cb) = each %$cb) { |
| 372 | 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 | ); |
| 373 | } |
399 | } |
| 374 | |
400 | |
| 375 | 0 |
401 | 0 |
|
|
402 | } |
|
|
403 | |
|
|
404 | sub 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; |
| 376 | } |
417 | } |
| 377 | |
418 | |
| 378 | =head2 The C<urxvt::term> Class |
419 | =head2 The C<urxvt::term> Class |
| 379 | |
420 | |
| 380 | =over 4 |
421 | =over 4 |
| … | |
… | |
| 542 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
583 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
| 543 | |
584 | |
| 544 | Returns the text of the entire row with number C<$row_number>. Row C<0> |
585 | Returns the text of the entire row with number C<$row_number>. Row C<0> |
| 545 | is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost |
586 | is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost |
| 546 | terminal line. The scrollback buffer starts at line C<-1> and extends to |
587 | terminal line. The scrollback buffer starts at line C<-1> and extends to |
| 547 | line C<< -$term->nsaved >>. |
588 | line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line |
|
|
589 | is requested. |
| 548 | |
590 | |
| 549 | If C<$new_text> is specified, it will replace characters in the current |
591 | If C<$new_text> is specified, it will replace characters in the current |
| 550 | line, starting at column C<$start_col> (default C<0>), which is useful |
592 | line, starting at column C<$start_col> (default C<0>), which is useful |
| 551 | to replace only parts of a line. The font index in the rendition will |
593 | to replace only parts of a line. The font index in the rendition will |
| 552 | automatically be updated. |
594 | automatically be updated. |
| … | |
… | |
| 574 | |
616 | |
| 575 | See the section on RENDITION, above. |
617 | See the section on RENDITION, above. |
| 576 | |
618 | |
| 577 | =item $length = $term->ROW_l ($row_number[, $new_length]) |
619 | =item $length = $term->ROW_l ($row_number[, $new_length]) |
| 578 | |
620 | |
| 579 | Returns the number of screen cells that are in use ("the line length"). If |
621 | Returns the number of screen cells that are in use ("the line |
| 580 | it is C<-1>, then the line is part of a multiple-row logical "line", which |
622 | length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the |
| 581 | means all characters are in use and it is continued on the next row. |
623 | line is joined with the following one. |
| 582 | |
624 | |
|
|
625 | =item $bool = $term->is_longer ($row_number) |
|
|
626 | |
|
|
627 | Returns true if the row is part of a multiple-row logical "line" (i.e. |
|
|
628 | joined with the following row), which means all characters are in use |
|
|
629 | and it is continued on the next row (and possibly a continuation of the |
|
|
630 | previous row(s)). |
|
|
631 | |
|
|
632 | =item $line = $term->line ($row_number) |
|
|
633 | |
|
|
634 | Create and return a new C<urxvt::line> object that stores information |
|
|
635 | about the logical line that row C<$row_number> is part of. It supports the |
|
|
636 | following methods: |
|
|
637 | |
|
|
638 | =over 4 |
|
|
639 | |
|
|
640 | =item $text = $line->t |
|
|
641 | |
|
|
642 | Returns the full text of the line, similar to C<ROW_t> |
|
|
643 | |
|
|
644 | =item $rend = $line->r |
|
|
645 | |
|
|
646 | Returns the full rendition array of the line, similar to C<ROW_r> |
|
|
647 | |
|
|
648 | =item $length = $line->l |
|
|
649 | |
|
|
650 | Returns 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 | |
|
|
656 | Return the row number of the first/last row of the line, respectively. |
|
|
657 | |
|
|
658 | =item $offset = $line->offset_of ($row, $col) |
|
|
659 | |
|
|
660 | Returns the character offset of the given row|col pair within the logical |
|
|
661 | line. |
|
|
662 | |
|
|
663 | =item ($row, $col) = $line->coord_of ($offset) |
|
|
664 | |
|
|
665 | Translates a string offset into terminal coordinates again. |
|
|
666 | |
|
|
667 | =back |
|
|
668 | |
|
|
669 | =cut |
|
|
670 | |
|
|
671 | sub 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 | |
|
|
689 | sub 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 | |
|
|
696 | sub 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 | |
|
|
706 | sub urxvt::line::beg { $_[0]{beg} } |
|
|
707 | sub urxvt::line::end { $_[0]{end} } |
|
|
708 | sub urxvt::line::l { $_[0]{len} } |
|
|
709 | |
|
|
710 | sub urxvt::line::offset_of { |
|
|
711 | my ($self, $row, $col) = @_; |
|
|
712 | |
|
|
713 | ($row - $self->{beg}) * $self->{term}->ncol + $col |
|
|
714 | } |
|
|
715 | |
|
|
716 | sub 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) |
| 583 | =item $text = $term->special_encode $string |
728 | =item $text = $term->special_encode $string |
| 584 | |
729 | |
| 585 | Converts a perl string into the special encoding used by rxvt-unicode, |
730 | Converts a perl string into the special encoding used by rxvt-unicode, |
| 586 | where one character corresponds to one screen cell. See |
731 | where one character corresponds to one screen cell. See |
| 587 | C<< $term->ROW_t >> for details. |
732 | C<< $term->ROW_t >> for details. |
