… | |
… | |
39 | |
39 | |
40 | =over 4 |
40 | =over 4 |
41 | |
41 | |
42 | =item selection |
42 | =item selection |
43 | |
43 | |
44 | Miscellaneous selection modifications. |
44 | Intelligent selection. This extension tries to be more intelligent when |
|
|
45 | the user extends selections (double-click). Right now, it tries to select |
|
|
46 | urls and complete shell-quoted arguments, which is very convenient, too, |
|
|
47 | if your F<ls> supports C<--quoting-style=shell>. |
|
|
48 | |
|
|
49 | It also offers the following bindable event: |
45 | |
50 | |
46 | =over 4 |
51 | =over 4 |
47 | |
52 | |
48 | =item rot13 |
53 | =item rot13 |
49 | |
54 | |
… | |
… | |
68 | =head2 General API Considerations |
73 | =head2 General API Considerations |
69 | |
74 | |
70 | All objects (such as terminals, time watchers etc.) are typical |
75 | All objects (such as terminals, time watchers etc.) are typical |
71 | reference-to-hash objects. The hash can be used to store anything you |
76 | reference-to-hash objects. The hash can be used to store anything you |
72 | like. All members starting with an underscore (such as C<_ptr> or |
77 | like. All members starting with an underscore (such as C<_ptr> or |
73 | C<_hook>) are reserved for internal uses and must not be accessed or |
78 | C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or |
74 | modified). |
79 | modified). |
75 | |
80 | |
76 | When objects are destroyed on the C++ side, the perl object hashes are |
81 | When objects are destroyed on the C++ side, the perl object hashes are |
77 | emptied, so its best to store related objects such as time watchers and |
82 | emptied, so its best to store related objects such as time watchers and |
78 | the like inside the terminal object so they get destroyed as soon as the |
83 | the like inside the terminal object so they get destroyed as soon as the |
79 | terminal is destroyed. |
84 | terminal is destroyed. |
80 | |
85 | |
81 | =head2 Hooks |
86 | =head2 Hooks |
82 | |
87 | |
83 | The following subroutines can be declared in loaded scripts, and will be called |
88 | The following subroutines can be declared in loaded scripts, and will be |
84 | whenever the relevant event happens. |
89 | called whenever the relevant event happens. |
|
|
90 | |
|
|
91 | The first argument passed to them is an object private to each terminal |
|
|
92 | and extension package. You can call all C<urxvt::term> methods on it, but |
|
|
93 | its not a real C<urxvt::term> object. Instead, the real C<urxvt::term> |
|
|
94 | object that is shared between all packages is stored in the C<term> |
|
|
95 | member. |
85 | |
96 | |
86 | All of them must return a boolean value. If it is true, then the event |
97 | All of them must return a boolean value. If it is true, then the event |
87 | counts as being I<consumed>, and the invocation of other hooks is skipped, |
98 | counts as being I<consumed>, and the invocation of other hooks is skipped, |
88 | and the relevant action might not be carried out by the C++ code. |
99 | and the relevant action might not be carried out by the C++ code. |
89 | |
100 | |
… | |
… | |
122 | requested from the server. The selection text can be queried and changed |
133 | requested from the server. The selection text can be queried and changed |
123 | by calling C<< $term->selection >>. |
134 | by calling C<< $term->selection >>. |
124 | |
135 | |
125 | Returning a true value aborts selection grabbing. It will still be hilighted. |
136 | Returning a true value aborts selection grabbing. It will still be hilighted. |
126 | |
137 | |
|
|
138 | =item on_sel_extend $term |
|
|
139 | |
|
|
140 | Called whenever the user tries to extend the selection (e.g. with a double |
|
|
141 | click) and is either supposed to return false (normal operation), or |
|
|
142 | should extend the selection itelf and return true to suppress the built-in |
|
|
143 | processing. |
|
|
144 | |
|
|
145 | See the F<selection> example extension. |
|
|
146 | |
127 | =item on_focus_in $term |
147 | =item on_focus_in $term |
128 | |
148 | |
129 | Called whenever the window gets the keyboard focus, before urxvt does |
149 | Called whenever the window gets the keyboard focus, before urxvt does |
130 | focus in processing. |
150 | focus in processing. |
131 | |
151 | |
… | |
… | |
151 | number of lines that will be in the scrollback buffer. |
171 | number 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 | |
155 | Called whenever the program(s) running in the urxvt window send output. |
175 | Called whenever the program(s) running in the urxvt window send output. |
|
|
176 | |
|
|
177 | =item on_osc_seq $term, $string |
|
|
178 | |
|
|
179 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
|
|
180 | operating system command) is processed. Cursor position and other state |
|
|
181 | information is up-to-date when this happens. For interoperability, the |
|
|
182 | string should start with the extension name and a colon, to distinguish |
|
|
183 | it from commands for other extensions, and this might be enforced in the |
|
|
184 | future. |
|
|
185 | |
|
|
186 | Be careful not ever to trust (in a security sense) the data you receive, |
|
|
187 | as its source can not easily be controleld (e-mail content, messages from |
|
|
188 | other users on the same system etc.). |
156 | |
189 | |
157 | =item on_refresh_begin $term |
190 | =item on_refresh_begin $term |
158 | |
191 | |
159 | Called just before the screen gets redrawn. Can be used for overlay |
192 | Called just before the screen gets redrawn. Can be used for overlay |
160 | or similar effects by modify terminal contents in refresh_begin, and |
193 | or similar effects by modify terminal contents in refresh_begin, and |
… | |
… | |
171 | C<perl:string> action bound to it (see description of the B<keysym> |
204 | C<perl:string> action bound to it (see description of the B<keysym> |
172 | resource in the @@RXVT_NAME@@(1) manpage). |
205 | resource in the @@RXVT_NAME@@(1) manpage). |
173 | |
206 | |
174 | =back |
207 | =back |
175 | |
208 | |
|
|
209 | =head2 Variables in the C<urxvt> Package |
|
|
210 | |
|
|
211 | =over 4 |
|
|
212 | |
|
|
213 | =item $urxvt::TERM |
|
|
214 | |
|
|
215 | The current terminal. Whenever a callback/Hook is bein executed, this |
|
|
216 | variable stores the current C<urxvt::term> object. |
|
|
217 | |
|
|
218 | =back |
|
|
219 | |
176 | =head2 Functions in the C<urxvt> Package |
220 | =head2 Functions in the C<urxvt> Package |
177 | |
221 | |
178 | =over 4 |
222 | =over 4 |
179 | |
223 | |
180 | =item urxvt::fatal $errormessage |
224 | =item urxvt::fatal $errormessage |
… | |
… | |
253 | =cut |
297 | =cut |
254 | |
298 | |
255 | package urxvt; |
299 | package urxvt; |
256 | |
300 | |
257 | use strict; |
301 | use strict; |
|
|
302 | use Scalar::Util (); |
258 | |
303 | |
259 | our $term; |
304 | our $TERM; |
260 | our @HOOKNAME; |
305 | our @HOOKNAME; |
261 | our $LIBDIR; |
306 | our $LIBDIR; |
262 | |
307 | |
263 | BEGIN { |
308 | BEGIN { |
264 | urxvt->bootstrap; |
309 | urxvt->bootstrap; |
… | |
… | |
289 | my $name = $HOOKNAME[$htype]; |
334 | my $name = $HOOKNAME[$htype]; |
290 | |
335 | |
291 | my $ref = $pkg->can ("on_" . lc $name) |
336 | my $ref = $pkg->can ("on_" . lc $name) |
292 | or next; |
337 | or next; |
293 | |
338 | |
294 | $term->{_hook}[$htype]{$ref*1} = $ref; |
339 | $TERM->{_hook}[$htype]{$pkg} = $ref; |
295 | $hook_count[$htype]++ |
340 | $hook_count[$htype]++ |
296 | or set_should_invoke $htype, 1; |
341 | or set_should_invoke $htype, 1; |
297 | } |
342 | } |
298 | } |
343 | } |
299 | |
344 | |
… | |
… | |
323 | } |
368 | } |
324 | } |
369 | } |
325 | |
370 | |
326 | # called by the rxvt core |
371 | # called by the rxvt core |
327 | sub invoke { |
372 | sub invoke { |
328 | local $term = shift; |
373 | local $TERM = shift; |
329 | my $htype = shift; |
374 | my $htype = shift; |
330 | |
375 | |
331 | if ($htype == 0) { # INIT |
376 | if ($htype == 0) { # INIT |
332 | my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl"); |
377 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
333 | |
378 | |
334 | for my $ext (split /:/, $term->resource ("perl_ext")) { |
379 | for my $ext (split /:/, $TERM->resource ("perl_ext")) { |
335 | my @files = grep -f $_, map "$_/$ext", @dirs; |
380 | my @files = grep -f $_, map "$_/$ext", @dirs; |
336 | |
381 | |
337 | if (@files) { |
382 | if (@files) { |
338 | register_package script_package $files[0]; |
383 | register_package script_package $files[0]; |
339 | } else { |
384 | } else { |
340 | warn "perl extension '$ext' not found in perl library search path\n"; |
385 | warn "perl extension '$ext' not found in perl library search path\n"; |
341 | } |
386 | } |
342 | } |
387 | } |
343 | |
388 | |
344 | } elsif ($htype == 1) { # DESTROY |
389 | } elsif ($htype == 1) { # DESTROY |
345 | if (my $hook = $term->{_hook}) { |
390 | if (my $hook = $TERM->{_hook}) { |
346 | for my $htype (0..$#$hook) { |
391 | for my $htype (0..$#$hook) { |
347 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
392 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
348 | or set_should_invoke $htype, 0; |
393 | or set_should_invoke $htype, 0; |
349 | } |
394 | } |
350 | } |
395 | } |
351 | } |
396 | } |
352 | |
397 | |
353 | my $cb = $term->{_hook}[$htype] |
398 | my $cb = $TERM->{_hook}[$htype] |
354 | or return; |
399 | or return; |
355 | |
400 | |
356 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")" |
401 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
357 | if $verbosity >= 10; |
402 | if $verbosity >= 10; |
358 | |
403 | |
|
|
404 | keys %$cb; |
|
|
405 | |
359 | while (my ($k, $v) = each %$cb) { |
406 | while (my ($pkg, $cb) = each %$cb) { |
360 | return 1 if $v->($term, @_); |
407 | return 1 |
|
|
408 | if $cb->( |
|
|
409 | $TERM->{$pkg} ||= do { |
|
|
410 | my $proxy = bless { }, urxvt::term::proxy::; |
|
|
411 | Scalar::Util::weaken ($proxy->{term} = $TERM); |
|
|
412 | $proxy |
|
|
413 | }, |
|
|
414 | @_, |
|
|
415 | ); |
361 | } |
416 | } |
362 | |
417 | |
363 | 0 |
418 | 0 |
|
|
419 | } |
|
|
420 | |
|
|
421 | sub urxvt::term::proxy::AUTOLOAD { |
|
|
422 | $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ |
|
|
423 | or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; |
|
|
424 | |
|
|
425 | eval qq{ |
|
|
426 | sub $urxvt::term::proxy::AUTOLOAD { |
|
|
427 | my \$proxy = shift; |
|
|
428 | \$proxy->{term}->$1 (\@_) |
|
|
429 | } |
|
|
430 | 1 |
|
|
431 | } or die "FATAL: unable to compile method forwarder: $@"; |
|
|
432 | |
|
|
433 | goto &$urxvt::term::proxy::AUTOLOAD; |
364 | } |
434 | } |
365 | |
435 | |
366 | =head2 The C<urxvt::term> Class |
436 | =head2 The C<urxvt::term> Class |
367 | |
437 | |
368 | =over 4 |
438 | =over 4 |
… | |
… | |
461 | right/bottom side, respectively. |
531 | right/bottom side, respectively. |
462 | |
532 | |
463 | This method returns an urxvt::overlay object. The overlay will be visible |
533 | This method returns an urxvt::overlay object. The overlay will be visible |
464 | as long as the perl object is referenced. |
534 | as long as the perl object is referenced. |
465 | |
535 | |
466 | Currently, the only method on the C<urxvt::overlay> object is C<set>: |
536 | The methods currently supported on C<urxvt::overlay> objects are: |
|
|
537 | |
|
|
538 | =over 4 |
467 | |
539 | |
468 | =item $overlay->set ($x, $y, $text, $rend) |
540 | =item $overlay->set ($x, $y, $text, $rend) |
469 | |
541 | |
470 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
542 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
471 | text in rxvt-unicode's special encoding and an array of rendition values |
543 | text in rxvt-unicode's special encoding and an array of rendition values |
472 | at a specific position inside the overlay. |
544 | at a specific position inside the overlay. |
473 | |
545 | |
|
|
546 | =item $overlay->hide |
|
|
547 | |
|
|
548 | If visible, hide the overlay, but do not destroy it. |
|
|
549 | |
|
|
550 | =item $overlay->show |
|
|
551 | |
|
|
552 | If hidden, display the overlay again. |
|
|
553 | |
|
|
554 | =back |
|
|
555 | |
474 | =item $cellwidth = $term->strwidth $string |
556 | =item $cellwidth = $term->strwidth $string |
475 | |
557 | |
476 | Returns the number of screen-cells this string would need. Correctly |
558 | Returns the number of screen-cells this string would need. Correctly |
477 | accounts for wide and combining characters. |
559 | accounts for wide and combining characters. |
478 | |
560 | |
… | |
… | |
518 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
600 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
519 | |
601 | |
520 | Returns the text of the entire row with number C<$row_number>. Row C<0> |
602 | Returns the text of the entire row with number C<$row_number>. Row C<0> |
521 | is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost |
603 | is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost |
522 | terminal line. The scrollback buffer starts at line C<-1> and extends to |
604 | terminal line. The scrollback buffer starts at line C<-1> and extends to |
523 | line C<< -$term->nsaved >>. |
605 | line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line |
|
|
606 | is requested. |
524 | |
607 | |
525 | If C<$new_text> is specified, it will replace characters in the current |
608 | If C<$new_text> is specified, it will replace characters in the current |
526 | line, starting at column C<$start_col> (default C<0>), which is useful |
609 | line, starting at column C<$start_col> (default C<0>), which is useful |
527 | to replace only parts of a line. The font index in the rendition will |
610 | to replace only parts of a line. The font index in the rendition will |
528 | automatically be updated. |
611 | automatically be updated. |
… | |
… | |
550 | |
633 | |
551 | See the section on RENDITION, above. |
634 | See the section on RENDITION, above. |
552 | |
635 | |
553 | =item $length = $term->ROW_l ($row_number[, $new_length]) |
636 | =item $length = $term->ROW_l ($row_number[, $new_length]) |
554 | |
637 | |
555 | Returns the number of screen cells that are in use ("the line length"). If |
638 | Returns the number of screen cells that are in use ("the line |
556 | it is C<-1>, then the line is part of a multiple-row logical "line", which |
639 | length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the |
557 | means all characters are in use and it is continued on the next row. |
640 | line is joined with the following one. |
558 | |
641 | |
|
|
642 | =item $bool = $term->is_longer ($row_number) |
|
|
643 | |
|
|
644 | Returns true if the row is part of a multiple-row logical "line" (i.e. |
|
|
645 | joined with the following row), which means all characters are in use |
|
|
646 | and it is continued on the next row (and possibly a continuation of the |
|
|
647 | previous row(s)). |
|
|
648 | |
|
|
649 | =item $line = $term->line ($row_number) |
|
|
650 | |
|
|
651 | Create and return a new C<urxvt::line> object that stores information |
|
|
652 | about the logical line that row C<$row_number> is part of. It supports the |
|
|
653 | following methods: |
|
|
654 | |
|
|
655 | =over 4 |
|
|
656 | |
|
|
657 | =item $text = $line->t |
|
|
658 | |
|
|
659 | Returns the full text of the line, similar to C<ROW_t> |
|
|
660 | |
|
|
661 | =item $rend = $line->r |
|
|
662 | |
|
|
663 | Returns the full rendition array of the line, similar to C<ROW_r> |
|
|
664 | |
|
|
665 | =item $length = $line->l |
|
|
666 | |
|
|
667 | Returns the length of the line in cells, similar to C<ROW_l>. |
|
|
668 | |
|
|
669 | =item $rownum = $line->beg |
|
|
670 | |
|
|
671 | =item $rownum = $line->end |
|
|
672 | |
|
|
673 | Return the row number of the first/last row of the line, respectively. |
|
|
674 | |
|
|
675 | =item $offset = $line->offset_of ($row, $col) |
|
|
676 | |
|
|
677 | Returns the character offset of the given row|col pair within the logical |
|
|
678 | line. |
|
|
679 | |
|
|
680 | =item ($row, $col) = $line->coord_of ($offset) |
|
|
681 | |
|
|
682 | Translates a string offset into terminal coordinates again. |
|
|
683 | |
|
|
684 | =back |
|
|
685 | |
|
|
686 | =cut |
|
|
687 | |
|
|
688 | sub urxvt::term::line { |
|
|
689 | my ($self, $row) = @_; |
|
|
690 | |
|
|
691 | my $maxrow = $self->nrow - 1; |
|
|
692 | |
|
|
693 | my ($beg, $end) = ($row, $row); |
|
|
694 | |
|
|
695 | --$beg while $self->ROW_is_longer ($beg - 1); |
|
|
696 | ++$end while $self->ROW_is_longer ($end) && $end < $maxrow; |
|
|
697 | |
|
|
698 | bless { |
|
|
699 | term => $self, |
|
|
700 | beg => $beg, |
|
|
701 | end => $end, |
|
|
702 | len => ($end - $beg) * $self->ncol + $self->ROW_l ($end), |
|
|
703 | }, urxvt::line:: |
|
|
704 | } |
|
|
705 | |
|
|
706 | sub urxvt::line::t { |
|
|
707 | my ($self) = @_; |
|
|
708 | |
|
|
709 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
|
|
710 | 0, $self->{len} |
|
|
711 | } |
|
|
712 | |
|
|
713 | sub urxvt::line::r { |
|
|
714 | my ($self) = @_; |
|
|
715 | |
|
|
716 | my $rend = [ |
|
|
717 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
|
|
718 | ]; |
|
|
719 | $#$rend = $self->{len} - 1; |
|
|
720 | $rend |
|
|
721 | } |
|
|
722 | |
|
|
723 | sub urxvt::line::beg { $_[0]{beg} } |
|
|
724 | sub urxvt::line::end { $_[0]{end} } |
|
|
725 | sub urxvt::line::l { $_[0]{len} } |
|
|
726 | |
|
|
727 | sub urxvt::line::offset_of { |
|
|
728 | my ($self, $row, $col) = @_; |
|
|
729 | |
|
|
730 | ($row - $self->{beg}) * $self->{term}->ncol + $col |
|
|
731 | } |
|
|
732 | |
|
|
733 | sub urxvt::line::coord_of { |
|
|
734 | my ($self, $offset) = @_; |
|
|
735 | |
|
|
736 | use integer; |
|
|
737 | |
|
|
738 | ( |
|
|
739 | $offset / $self->{term}->ncol + $self->{beg}, |
|
|
740 | $offset % $self->{term}->ncol |
|
|
741 | ) |
|
|
742 | } |
|
|
743 | |
|
|
744 | =item ($row, $col) = $line->coord_of ($offset) |
559 | =item $text = $term->special_encode $string |
745 | =item $text = $term->special_encode $string |
560 | |
746 | |
561 | Converts a perl string into the special encoding used by rxvt-unicode, |
747 | Converts a perl string into the special encoding used by rxvt-unicode, |
562 | where one character corresponds to one screen cell. See |
748 | where one character corresponds to one screen cell. See |
563 | C<< $term->ROW_t >> for details. |
749 | C<< $term->ROW_t >> for details. |
… | |
… | |
677 | This variable controls the verbosity level of the perl extension. Higher |
863 | This variable controls the verbosity level of the perl extension. Higher |
678 | numbers indicate more verbose output. |
864 | numbers indicate more verbose output. |
679 | |
865 | |
680 | =over 4 |
866 | =over 4 |
681 | |
867 | |
682 | =item 0 - only fatal messages |
868 | =item =0 - only fatal messages |
683 | |
869 | |
684 | =item 3 - script loading and management |
870 | =item =3 - script loading and management |
685 | |
871 | |
686 | =item 10 - all events received |
872 | =item =10 - all events received |
687 | |
873 | |
688 | =back |
874 | =back |
689 | |
875 | |
690 | =head1 AUTHOR |
876 | =head1 AUTHOR |
691 | |
877 | |