… | |
… | |
39 | |
39 | |
40 | =over 4 |
40 | =over 4 |
41 | |
41 | |
42 | =item selection |
42 | =item selection |
43 | |
43 | |
44 | Intelligent selection. This etxension tries to be more intelligent when the user |
44 | Intelligent selection. This extension tries to be more intelligent when |
45 | extends selections (double-click). |
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>. |
46 | |
48 | |
47 | It also offers the following bindable event: |
49 | It also offers the following bindable event: |
48 | |
50 | |
49 | =over 4 |
51 | =over 4 |
50 | |
52 | |
… | |
… | |
63 | =item example-refresh-hooks |
65 | =item example-refresh-hooks |
64 | |
66 | |
65 | Displays a very simple digital clock in the upper right corner of the |
67 | Displays a very simple digital clock in the upper right corner of the |
66 | window. Illustrates overwriting the refresh callbacks to create your own |
68 | window. Illustrates overwriting the refresh callbacks to create your own |
67 | overlays or changes. |
69 | overlays or changes. |
|
|
70 | |
|
|
71 | =item mark-urls |
|
|
72 | |
|
|
73 | A not very useful example of filtering all text output to the terminal, by |
|
|
74 | underlining all urls that matches a certain regex (i.e. some urls :). It |
|
|
75 | is not very useful because urls that are output in multiple steps (e.g. |
|
|
76 | when typing them) do not get marked. |
68 | |
77 | |
69 | =back |
78 | =back |
70 | |
79 | |
71 | =head2 General API Considerations |
80 | =head2 General API Considerations |
72 | |
81 | |
… | |
… | |
79 | When objects are destroyed on the C++ side, the perl object hashes are |
88 | 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 |
89 | 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 |
90 | the like inside the terminal object so they get destroyed as soon as the |
82 | terminal is destroyed. |
91 | terminal is destroyed. |
83 | |
92 | |
|
|
93 | Argument names also often indicate the type of a parameter. Here are some |
|
|
94 | hints on what they mean: |
|
|
95 | |
|
|
96 | =over 4 |
|
|
97 | |
|
|
98 | =item $text |
|
|
99 | |
|
|
100 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
|
|
101 | always represents one screen cell. See L<row_t> for a discussion of this format. |
|
|
102 | |
|
|
103 | =item $string |
|
|
104 | |
|
|
105 | A perl text string, with an emphasis on I<text>. It can store all unicode |
|
|
106 | characters and is to be distinguished with text encoded in a specific |
|
|
107 | encoding (often locale-specific) and binary data. |
|
|
108 | |
|
|
109 | =item $octets |
|
|
110 | |
|
|
111 | Either binary data or - more common - a text string encoded in a |
|
|
112 | locale-specific way. |
|
|
113 | |
|
|
114 | =back |
|
|
115 | |
84 | =head2 Hooks |
116 | =head2 Hooks |
85 | |
117 | |
86 | The following subroutines can be declared in loaded scripts, and will be |
118 | The following subroutines can be declared in loaded scripts, and will be |
87 | called whenever the relevant event happens. |
119 | called whenever the relevant event happens. |
88 | |
120 | |
… | |
… | |
169 | number of lines that will be in the scrollback buffer. |
201 | number of lines that will be in the scrollback buffer. |
170 | |
202 | |
171 | =item on_tty_activity $term *NYI* |
203 | =item on_tty_activity $term *NYI* |
172 | |
204 | |
173 | Called whenever the program(s) running in the urxvt window send output. |
205 | Called whenever the program(s) running in the urxvt window send output. |
|
|
206 | |
|
|
207 | =item on_osc_seq $term, $string |
|
|
208 | |
|
|
209 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
|
|
210 | operating system command) is processed. Cursor position and other state |
|
|
211 | information is up-to-date when this happens. For interoperability, the |
|
|
212 | string should start with the extension name and a colon, to distinguish |
|
|
213 | it from commands for other extensions, and this might be enforced in the |
|
|
214 | future. |
|
|
215 | |
|
|
216 | Be careful not ever to trust (in a security sense) the data you receive, |
|
|
217 | as its source can not easily be controleld (e-mail content, messages from |
|
|
218 | other users on the same system etc.). |
|
|
219 | |
|
|
220 | =item on_add_lines $term, $string |
|
|
221 | |
|
|
222 | Called whenever text is about to be output, with the text as argument. You |
|
|
223 | can filter/change and output the text yourself by returning a true value |
|
|
224 | and calling C<< $term->scr_add_lines >> yourself. Please note that this |
|
|
225 | might be very slow, however, as your hook is called for B<all> text being |
|
|
226 | output. |
174 | |
227 | |
175 | =item on_refresh_begin $term |
228 | =item on_refresh_begin $term |
176 | |
229 | |
177 | Called just before the screen gets redrawn. Can be used for overlay |
230 | Called just before the screen gets redrawn. Can be used for overlay |
178 | or similar effects by modify terminal contents in refresh_begin, and |
231 | or similar effects by modify terminal contents in refresh_begin, and |
… | |
… | |
351 | |
404 | |
352 | $pkg |
405 | $pkg |
353 | } |
406 | } |
354 | } |
407 | } |
355 | |
408 | |
|
|
409 | our $retval; # return value for urxvt |
|
|
410 | |
356 | # called by the rxvt core |
411 | # called by the rxvt core |
357 | sub invoke { |
412 | sub invoke { |
358 | local $TERM = shift; |
413 | local $TERM = shift; |
359 | my $htype = shift; |
414 | my $htype = shift; |
360 | |
415 | |
361 | if ($htype == 0) { # INIT |
416 | if ($htype == 0) { # INIT |
362 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
417 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
363 | |
418 | |
364 | for my $ext (split /:/, $TERM->resource ("perl_ext")) { |
419 | for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
365 | my @files = grep -f $_, map "$_/$ext", @dirs; |
420 | my @files = grep -f $_, map "$_/$ext", @dirs; |
366 | |
421 | |
367 | if (@files) { |
422 | if (@files) { |
368 | register_package script_package $files[0]; |
423 | register_package script_package $files[0]; |
369 | } else { |
424 | } else { |
370 | warn "perl extension '$ext' not found in perl library search path\n"; |
425 | warn "perl extension '$ext' not found in perl library search path\n"; |
371 | } |
426 | } |
372 | } |
427 | } |
|
|
428 | } |
373 | |
429 | |
|
|
430 | $retval = undef; |
|
|
431 | |
|
|
432 | if (my $cb = $TERM->{_hook}[$htype]) { |
|
|
433 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
|
|
434 | if $verbosity >= 10; |
|
|
435 | |
|
|
436 | keys %$cb; |
|
|
437 | |
|
|
438 | while (my ($pkg, $cb) = each %$cb) { |
|
|
439 | $retval = $cb->( |
|
|
440 | $TERM->{_pkg}{$pkg} ||= do { |
|
|
441 | my $proxy = bless { }, urxvt::term::proxy::; |
|
|
442 | Scalar::Util::weaken ($proxy->{term} = $TERM); |
|
|
443 | $proxy |
|
|
444 | }, |
|
|
445 | @_, |
|
|
446 | ) and last; |
|
|
447 | } |
|
|
448 | } |
|
|
449 | |
374 | } elsif ($htype == 1) { # DESTROY |
450 | if ($htype == 1) { # DESTROY |
|
|
451 | # remove hooks if unused |
375 | if (my $hook = $TERM->{_hook}) { |
452 | if (my $hook = $TERM->{_hook}) { |
376 | for my $htype (0..$#$hook) { |
453 | for my $htype (0..$#$hook) { |
377 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
454 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
378 | or set_should_invoke $htype, 0; |
455 | or set_should_invoke $htype, 0; |
379 | } |
456 | } |
380 | } |
457 | } |
|
|
458 | |
|
|
459 | # clear package objects |
|
|
460 | %$_ = () for values %{ $TERM->{_pkg} }; |
|
|
461 | |
|
|
462 | # clear package |
|
|
463 | %$TERM = (); |
381 | } |
464 | } |
382 | |
465 | |
383 | my $cb = $TERM->{_hook}[$htype] |
466 | $retval |
384 | or return; |
|
|
385 | |
|
|
386 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
|
|
387 | if $verbosity >= 10; |
|
|
388 | |
|
|
389 | keys %$cb; |
|
|
390 | |
|
|
391 | while (my ($pkg, $cb) = each %$cb) { |
|
|
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 | ); |
|
|
401 | } |
|
|
402 | |
|
|
403 | 0 |
|
|
404 | } |
467 | } |
405 | |
468 | |
406 | sub urxvt::term::proxy::AUTOLOAD { |
469 | sub urxvt::term::proxy::AUTOLOAD { |
407 | $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ |
470 | $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ |
408 | or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; |
471 | or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; |
… | |
… | |
446 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
509 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
447 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
510 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
448 | display_name embed ext_bwidth fade font geometry hold iconName |
511 | display_name embed ext_bwidth fade font geometry hold iconName |
449 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
512 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
450 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
513 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
451 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext |
514 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
452 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
515 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
453 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
516 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
454 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
517 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
455 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
518 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
456 | shade term_name title transparent transparent_all tripleclickwords |
519 | shade term_name title transparent transparent_all tripleclickwords |
… | |
… | |
462 | my ($self, $name) = (shift, shift); |
525 | my ($self, $name) = (shift, shift); |
463 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
526 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
464 | goto &urxvt::term::_resource; |
527 | goto &urxvt::term::_resource; |
465 | } |
528 | } |
466 | |
529 | |
|
|
530 | =item $rend = $term->rstyle ([$new_rstyle]) |
|
|
531 | |
|
|
532 | Return and optionally change the current rendition. Text that is output by |
|
|
533 | the terminal application will use this style. |
|
|
534 | |
|
|
535 | =item ($row, $col) = $term->screen_cur ([$row, $col]) |
|
|
536 | |
|
|
537 | Return the current coordinates of the text cursor position and optionally |
|
|
538 | set it (which is usually bad as applications don't expect that). |
|
|
539 | |
467 | =item ($row, $col) = $term->selection_mark ([$row, $col]) |
540 | =item ($row, $col) = $term->selection_mark ([$row, $col]) |
468 | |
541 | |
469 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
542 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
470 | |
543 | |
471 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
544 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
… | |
… | |
485 | #=item $term->overlay ($x, $y, $text) |
558 | #=item $term->overlay ($x, $y, $text) |
486 | # |
559 | # |
487 | #Create a simple multi-line overlay box. See the next method for details. |
560 | #Create a simple multi-line overlay box. See the next method for details. |
488 | # |
561 | # |
489 | #=cut |
562 | #=cut |
490 | |
563 | # |
491 | sub urxvt::term::scr_overlay { |
564 | #sub urxvt::term::scr_overlay { |
492 | die; |
|
|
493 | my ($self, $x, $y, $text) = @_; |
565 | # my ($self, $x, $y, $text) = @_; |
494 | |
566 | # |
495 | my @lines = split /\n/, $text; |
567 | # my @lines = split /\n/, $text; |
496 | |
568 | # |
497 | my $w = 0; |
569 | # my $w = 0; |
498 | for (map $self->strwidth ($_), @lines) { |
570 | # for (map $self->strwidth ($_), @lines) { |
499 | $w = $_ if $w < $_; |
571 | # $w = $_ if $w < $_; |
500 | } |
572 | # } |
501 | |
573 | # |
502 | $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
574 | # $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
503 | $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
575 | # $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
504 | } |
576 | #} |
505 | |
577 | |
506 | =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
578 | =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
507 | |
579 | |
508 | Create a new (empty) overlay at the given position with the given |
580 | Create a new (empty) overlay at the given position with the given |
509 | width/height. C<$rstyle> defines the initial rendition style |
581 | width/height. C<$rstyle> defines the initial rendition style |
… | |
… | |
549 | |
621 | |
550 | =item $string = $term->locale_decode $octets |
622 | =item $string = $term->locale_decode $octets |
551 | |
623 | |
552 | Convert the given locale-encoded octets into a perl string. |
624 | Convert the given locale-encoded octets into a perl string. |
553 | |
625 | |
|
|
626 | =item $term->scr_add_lines ($string) |
|
|
627 | |
|
|
628 | Write the given text string to the screen, as if output by the application |
|
|
629 | running inside the terminal. It may not contain command sequences (escape |
|
|
630 | codes), but is free to use line feeds, carriage returns and tabs. The |
|
|
631 | string is a normal text string, not in locale-dependent encoding. |
|
|
632 | |
|
|
633 | Normally its not a good idea to use this function, as programs might be |
|
|
634 | confused by changes in cursor position or scrolling. Its useful inside a |
|
|
635 | C<on_add_lines> hook, though. |
|
|
636 | |
554 | =item $term->tt_write ($octets) |
637 | =item $term->tt_write ($octets) |
555 | |
638 | |
556 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
639 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
557 | pass characters instead of octets, you should convert your strings first |
640 | pass characters instead of octets, you should convert your strings first |
558 | to the locale-specific encoding using C<< $term->locale_encode >>. |
641 | to the locale-specific encoding using C<< $term->locale_encode >>. |
559 | |
642 | |
|
|
643 | =item $window_width = $term->width |
|
|
644 | |
|
|
645 | =item $window_height = $term->height |
|
|
646 | |
|
|
647 | =item $font_width = $term->fwidth |
|
|
648 | |
|
|
649 | =item $font_height = $term->fheight |
|
|
650 | |
|
|
651 | =item $font_ascent = $term->fbase |
|
|
652 | |
560 | =item $nrow = $term->nrow |
653 | =item $terminal_rows = $term->nrow |
561 | |
654 | |
562 | =item $ncol = $term->ncol |
655 | =item $terminal_columns = $term->ncol |
563 | |
656 | |
564 | Return the number of rows/columns of the terminal window (i.e. as |
657 | =item $has_focus = $term->focus |
565 | specified by C<-geometry>, excluding any scrollback). |
|
|
566 | |
658 | |
567 | =item $nsaved = $term->nsaved |
659 | =item $is_mapped = $term->mapped |
568 | |
660 | |
569 | Returns the number of lines in the scrollback buffer. |
661 | =item $max_scrollback = $term->saveLines |
|
|
662 | |
|
|
663 | =item $nrow_plus_saveLines = $term->total_rows |
|
|
664 | |
|
|
665 | =item $lines_in_scrollback = $term->nsaved |
|
|
666 | |
|
|
667 | Return various integers describing terminal characteristics. |
570 | |
668 | |
571 | =item $view_start = $term->view_start ([$newvalue]) |
669 | =item $view_start = $term->view_start ([$newvalue]) |
572 | |
670 | |
573 | Returns the negative row number of the topmost line. Minimum value is |
671 | Returns the negative row number of the topmost line. Minimum value is |
574 | C<0>, which displays the normal terminal contents. Larger values scroll |
672 | C<0>, which displays the normal terminal contents. Larger values scroll |
… | |
… | |
848 | This variable controls the verbosity level of the perl extension. Higher |
946 | This variable controls the verbosity level of the perl extension. Higher |
849 | numbers indicate more verbose output. |
947 | numbers indicate more verbose output. |
850 | |
948 | |
851 | =over 4 |
949 | =over 4 |
852 | |
950 | |
853 | =item 0 - only fatal messages |
951 | =item =0 - only fatal messages |
854 | |
952 | |
855 | =item 3 - script loading and management |
953 | =item =3 - script loading and management |
856 | |
954 | |
857 | =item 10 - all events received |
955 | =item =10 - all events received |
858 | |
956 | |
859 | =back |
957 | =back |
860 | |
958 | |
861 | =head1 AUTHOR |
959 | =head1 AUTHOR |
862 | |
960 | |