| … | |
… | |
| 43 | |
43 | |
| 44 | Or by adding them to the resource for extensions loaded by default: |
44 | Or by adding them to the resource for extensions loaded by default: |
| 45 | |
45 | |
| 46 | URxvt.perl-ext-common: default,selection-autotransform |
46 | URxvt.perl-ext-common: default,selection-autotransform |
| 47 | |
47 | |
| 48 | Extensions that add command line parameters or resources on their own are |
48 | Extensions may add additional resources and C<actions>, i.e., methods |
| 49 | loaded automatically when used. |
49 | which can be bound to a key and invoked by the user. An extension can |
|
|
50 | define the resources it support using so called META comments, |
|
|
51 | described below. Similarly to builtin resources, extension resources |
|
|
52 | can also be specified on the command line as long options (with C<.> |
|
|
53 | replaced by C<->), in which case the corresponding extension is loaded |
|
|
54 | automatically. For this to work the extension B<must> define META |
|
|
55 | comments for its resources. |
| 50 | |
56 | |
| 51 | =head1 API DOCUMENTATION |
57 | =head1 API DOCUMENTATION |
| 52 | |
58 | |
| 53 | =head2 General API Considerations |
59 | =head2 General API Considerations |
| 54 | |
60 | |
| … | |
… | |
| 106 | C<urxvt::term> class on this object. |
112 | C<urxvt::term> class on this object. |
| 107 | |
113 | |
| 108 | Additional methods only supported for extension objects are described in |
114 | Additional methods only supported for extension objects are described in |
| 109 | the C<urxvt::extension> section below. |
115 | the C<urxvt::extension> section below. |
| 110 | |
116 | |
|
|
117 | =head2 META comments |
|
|
118 | |
|
|
119 | Rxvt-unicode recognizes special meta comments in extensions that define |
|
|
120 | different types of metadata. These comments are scanned whenever a |
|
|
121 | terminal is created and are typically used to autoload extensions when |
|
|
122 | their resources or command line parameters are used. |
|
|
123 | |
|
|
124 | Currently, it recognises only one such comment: |
|
|
125 | |
|
|
126 | =over 4 |
|
|
127 | |
|
|
128 | =item #:META:RESOURCE:name:type:desc |
|
|
129 | |
|
|
130 | The RESOURCE comment defines a resource used by the extension, where |
|
|
131 | C<name> is the resource name, C<type> is the resource type, C<boolean> |
|
|
132 | or C<string>, and C<desc> is the resource description. |
|
|
133 | |
|
|
134 | The extension will be autoloaded when this resource is specified or used |
|
|
135 | as a command line parameter. |
|
|
136 | |
|
|
137 | =back |
|
|
138 | |
| 111 | =head2 Hooks |
139 | =head2 Hooks |
| 112 | |
140 | |
| 113 | The following subroutines can be declared in extension files, and will be |
141 | The following subroutines can be declared in extension files, and will be |
| 114 | called whenever the relevant event happens. |
142 | called whenever the relevant event happens. |
| 115 | |
143 | |
| … | |
… | |
| 281 | |
309 | |
| 282 | =item on_refresh_end $term |
310 | =item on_refresh_end $term |
| 283 | |
311 | |
| 284 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
312 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
| 285 | |
313 | |
|
|
314 | =item on_action $term, $string |
|
|
315 | |
|
|
316 | Called whenever an action is invoked for the corresponding extension |
|
|
317 | (e.g. via a C<extension:string> builtin action bound to a key, see |
|
|
318 | description of the B<keysym> resource in the urxvt(1) manpage). The |
|
|
319 | event is simply the action string. Note that an action event is always |
|
|
320 | associated to a single extension. |
|
|
321 | |
| 286 | =item on_user_command $term, $string *DEPRECATED* |
322 | =item on_user_command $term, $string *DEPRECATED* |
| 287 | |
323 | |
| 288 | Called whenever a user-configured event is being activated (e.g. via |
324 | Called whenever a user-configured event is being activated (e.g. via |
| 289 | a C<perl:string> action bound to a key, see description of the B<keysym> |
325 | a C<perl:string> action bound to a key, see description of the B<keysym> |
| 290 | resource in the urxvt(1) manpage). |
326 | resource in the urxvt(1) manpage). |
| 291 | |
327 | |
| 292 | The event is simply the action string. This interface is going away in |
328 | The event is simply the action string. This interface is going away in |
| 293 | preference to the C<< ->register_keysym_action >> method. |
329 | preference to the C<on_action> hook. |
| 294 | |
|
|
| 295 | =item on_register_command $term, $keysym, $modifiermask, $string |
|
|
| 296 | |
|
|
| 297 | Called after parsing a keysym resource but before registering the |
|
|
| 298 | associated binding. If this hook returns a true value the binding |
|
|
| 299 | is not registered. It can be used to modify a binding by calling |
|
|
| 300 | C<register_command>. |
|
|
| 301 | |
330 | |
| 302 | =item on_resize_all_windows $term, $new_width, $new_height |
331 | =item on_resize_all_windows $term, $new_width, $new_height |
| 303 | |
332 | |
| 304 | Called just after the new window size has been calculated, but before |
333 | Called just after the new window size has been calculated, but before |
| 305 | windows are actually being resized or hints are being set. If this hook |
334 | windows are actually being resized or hints are being set. If this hook |
| … | |
… | |
| 350 | manpage), with the additional members C<row> and C<col>, which are the |
379 | manpage), with the additional members C<row> and C<col>, which are the |
| 351 | (real, not screen-based) row and column under the mouse cursor. |
380 | (real, not screen-based) row and column under the mouse cursor. |
| 352 | |
381 | |
| 353 | C<on_key_press> additionally receives the string rxvt-unicode would |
382 | C<on_key_press> additionally receives the string rxvt-unicode would |
| 354 | output, if any, in locale-specific encoding. |
383 | output, if any, in locale-specific encoding. |
| 355 | |
|
|
| 356 | subwindow. |
|
|
| 357 | |
384 | |
| 358 | =item on_client_message $term, $event |
385 | =item on_client_message $term, $event |
| 359 | |
386 | |
| 360 | =item on_wm_protocols $term, $event |
387 | =item on_wm_protocols $term, $event |
| 361 | |
388 | |
| … | |
… | |
| 489 | ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
516 | ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
| 490 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
517 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
| 491 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify |
518 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify |
| 492 | |
519 | |
| 493 | Various constants for use in X calls and event processing. |
520 | Various constants for use in X calls and event processing. |
|
|
521 | |
|
|
522 | =item urxvt::PrivMode_132, PrivMode_132OK, PrivMode_rVideo, PrivMode_relOrigin, |
|
|
523 | PrivMode_Screen, PrivMode_Autowrap, PrivMode_aplCUR, PrivMode_aplKP, |
|
|
524 | PrivMode_HaveBackSpace, PrivMode_BackSpace, PrivMode_ShiftKeys, |
|
|
525 | PrivMode_VisibleCursor, PrivMode_MouseX10, PrivMode_MouseX11, |
|
|
526 | PrivMode_scrollBar, PrivMode_TtyOutputInh, PrivMode_Keypress, |
|
|
527 | PrivMode_smoothScroll, PrivMode_vt52, PrivMode_LFNL, PrivMode_MouseBtnEvent, |
|
|
528 | PrivMode_MouseAnyEvent, PrivMode_BracketPaste, PrivMode_ExtModeMouse, |
|
|
529 | PrivMode_ExtMouseRight, PrivMode_BlinkingCursor, PrivMode_mouse_report, |
|
|
530 | PrivMode_Default |
|
|
531 | |
|
|
532 | Constants for checking DEC private modes. |
| 494 | |
533 | |
| 495 | =back |
534 | =back |
| 496 | |
535 | |
| 497 | =head2 RENDITION |
536 | =head2 RENDITION |
| 498 | |
537 | |
| … | |
… | |
| 564 | no warnings 'utf8'; |
603 | no warnings 'utf8'; |
| 565 | |
604 | |
| 566 | sub parse_resource { |
605 | sub parse_resource { |
| 567 | my ($term, $name, $isarg, $longopt, $flag, $value) = @_; |
606 | my ($term, $name, $isarg, $longopt, $flag, $value) = @_; |
| 568 | |
607 | |
| 569 | $name =~ y/-/./ if $isarg; |
|
|
| 570 | |
|
|
| 571 | $term->scan_meta; |
608 | $term->scan_extensions; |
| 572 | |
609 | |
|
|
610 | # iterating over all resources has quadratic time overhead |
|
|
611 | # overall, maybe this could be optimised? |
| 573 | my $r = $term->{meta}{resource}; |
612 | my $r = $term->{meta}{resource}; |
| 574 | keys %$r; # reset iterator |
613 | keys %$r; # reset iterator |
| 575 | while (my ($pattern, $v) = each %$r) { |
614 | while (my ($k, $v) = each %$r) { |
| 576 | if ( |
615 | my $pattern = $k; |
|
|
616 | $pattern =~ y/./-/ if $isarg; |
|
|
617 | my $prefix = $name; |
|
|
618 | my $suffix; |
| 577 | $pattern =~ /\.$/ |
619 | if ($pattern =~ /\-$/) { |
| 578 | ? $pattern eq substr $name, 0, length $pattern |
620 | $prefix = substr $name, 0, length $pattern; |
| 579 | : $pattern eq $name |
621 | $suffix = substr $name, length $pattern; |
| 580 | ) { |
622 | } |
|
|
623 | if ($pattern eq $prefix) { |
| 581 | $name = "$urxvt::RESCLASS.$name"; |
624 | $name = "$urxvt::RESCLASS.$k$suffix"; |
| 582 | |
625 | |
| 583 | push @{ $term->{perl_ext_3} }, $v->[0]; |
626 | push @{ $term->{perl_ext_3} }, $v->[0]; |
|
|
627 | |
|
|
628 | return 1 unless $isarg; |
| 584 | |
629 | |
| 585 | if ($v->[1] eq "boolean") { |
630 | if ($v->[1] eq "boolean") { |
| 586 | $term->put_option_db ($name, $flag ? "true" : "false"); |
631 | $term->put_option_db ($name, $flag ? "true" : "false"); |
| 587 | return 1; |
632 | return 1; |
| 588 | } else { |
633 | } else { |
| … | |
… | |
| 596 | } |
641 | } |
| 597 | |
642 | |
| 598 | sub usage { |
643 | sub usage { |
| 599 | my ($term, $usage_type) = @_; |
644 | my ($term, $usage_type) = @_; |
| 600 | |
645 | |
| 601 | $term->scan_meta; |
646 | $term->scan_extensions; |
| 602 | |
647 | |
| 603 | my $r = $term->{meta}{resource}; |
648 | my $r = $term->{meta}{resource}; |
| 604 | |
649 | |
| 605 | for my $pattern (sort keys %$r) { |
650 | for my $pattern (sort keys %$r) { |
| 606 | my ($ext, $type, $desc) = @{ $r->{$pattern} }; |
651 | my ($ext, $type, $desc) = @{ $r->{$pattern} }; |
| … | |
… | |
| 670 | my $htype = shift; |
715 | my $htype = shift; |
| 671 | |
716 | |
| 672 | if ($htype == HOOK_INIT) { |
717 | if ($htype == HOOK_INIT) { |
| 673 | my @dirs = $TERM->perl_libdirs; |
718 | my @dirs = $TERM->perl_libdirs; |
| 674 | |
719 | |
|
|
720 | $TERM->scan_extensions; |
|
|
721 | |
| 675 | my %ext_arg; |
722 | my %ext_arg; |
| 676 | |
723 | |
| 677 | { |
724 | { |
| 678 | my @init = @TERM_INIT; |
725 | my @init = @TERM_INIT; |
| 679 | @TERM_INIT = (); |
726 | @TERM_INIT = (); |
| … | |
… | |
| 682 | @TERM_EXT = (); |
729 | @TERM_EXT = (); |
| 683 | $TERM->register_package ($_) for @pkg; |
730 | $TERM->register_package ($_) for @pkg; |
| 684 | } |
731 | } |
| 685 | |
732 | |
| 686 | for ( |
733 | for ( |
|
|
734 | (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2), |
| 687 | @{ delete $TERM->{perl_ext_3} }, |
735 | @{ delete $TERM->{perl_ext_3} } |
| 688 | grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2 |
|
|
| 689 | ) { |
736 | ) { |
| 690 | if ($_ eq "default") { |
737 | if ($_ eq "default") { |
|
|
738 | |
|
|
739 | $ext_arg{$_} = [] |
| 691 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
740 | for qw(selection option-popup selection-popup readline searchable-scrollback); |
|
|
741 | |
|
|
742 | for ($TERM->_keysym_resources) { |
|
|
743 | next if /^(?:string|command|builtin|builtin-string|perl)/; |
|
|
744 | next unless /^([A-Za-z0-9_\-]+):/; |
|
|
745 | |
|
|
746 | my $ext = $1; |
|
|
747 | |
|
|
748 | $ext_arg{$ext} = []; |
|
|
749 | } |
|
|
750 | |
| 692 | } elsif (/^-(.*)$/) { |
751 | } elsif (/^-(.*)$/) { |
| 693 | delete $ext_arg{$1}; |
752 | delete $ext_arg{$1}; |
|
|
753 | |
| 694 | } elsif (/^([^<]+)<(.*)>$/) { |
754 | } elsif (/^([^<]+)<(.*)>$/) { |
| 695 | push @{ $ext_arg{$1} }, $2; |
755 | push @{ $ext_arg{$1} }, $2; |
|
|
756 | |
| 696 | } else { |
757 | } else { |
| 697 | $ext_arg{$_} ||= []; |
758 | $ext_arg{$_} ||= []; |
| 698 | } |
759 | } |
| 699 | } |
760 | } |
| 700 | |
761 | |
| … | |
… | |
| 716 | |
777 | |
| 717 | if (my $cb = $TERM->{_hook}[$htype]) { |
778 | if (my $cb = $TERM->{_hook}[$htype]) { |
| 718 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
779 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
| 719 | if $verbosity >= 10; |
780 | if $verbosity >= 10; |
| 720 | |
781 | |
| 721 | for my $pkg ( |
782 | if ($htype == HOOK_ACTION) { |
| 722 | # this hook is only sent to the extension with the name |
783 | # this hook is only sent to the extension with the name |
| 723 | # matching the first arg |
784 | # matching the first arg |
| 724 | $htype == HOOK_KEYBOARD_DISPATCH |
785 | my $pkg = shift; |
| 725 | ? exists $cb->{"urxvt::ext::$_[0]"} ? "urxvt::ext::" . shift : return undef |
786 | $pkg =~ y/-/_/; |
| 726 | : keys %$cb |
787 | $pkg = "urxvt::ext::$pkg"; |
|
|
788 | |
|
|
789 | $cb = $cb->{$pkg} |
|
|
790 | or return undef; #TODO: maybe warn user? |
|
|
791 | |
|
|
792 | $cb = { $pkg => $cb }; |
| 727 | ) { |
793 | } |
|
|
794 | |
|
|
795 | for my $pkg (keys %$cb) { |
| 728 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) }; |
796 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) }; |
| 729 | $retval ||= $retval_; |
797 | $retval ||= $retval_; |
| 730 | |
798 | |
| 731 | if ($@) { |
799 | if ($@) { |
| 732 | $TERM->ungrab; # better to lose the grab than the session |
800 | $TERM->ungrab; # better to lose the grab than the session |
| … | |
… | |
| 918 | } |
986 | } |
| 919 | |
987 | |
| 920 | bless \%disable, "urxvt::extension::on_disable" |
988 | bless \%disable, "urxvt::extension::on_disable" |
| 921 | } |
989 | } |
| 922 | |
990 | |
|
|
991 | =item $self->bind_action ($hotkey, $action) |
|
|
992 | |
| 923 | =item $self->x_resource ($pattern) |
993 | =item $self->x_resource ($pattern) |
| 924 | |
994 | |
| 925 | =item $self->x_resource_boolean ($pattern) |
995 | =item $self->x_resource_boolean ($pattern) |
| 926 | |
996 | |
| 927 | These methods support an additional C<%> prefix when called on an |
997 | These methods support an additional C<%> prefix for C<$action> or |
| 928 | extension object - see the description of these methods in the |
998 | C<$pattern> when called on an extension object, compared to the |
|
|
999 | C<urxvt::term> methods of the same name - see the description of these |
| 929 | C<urxvt::term> class for details. |
1000 | methods in the C<urxvt::term> class for details. |
| 930 | |
1001 | |
| 931 | =cut |
1002 | =cut |
|
|
1003 | |
|
|
1004 | sub bind_action { |
|
|
1005 | my ($self, $hotkey, $action) = @_; |
|
|
1006 | $action =~ s/^%:/$_[0]{_name}:/; |
|
|
1007 | $self->{term}->bind_action ($hotkey, $action) |
|
|
1008 | } |
| 932 | |
1009 | |
| 933 | sub x_resource { |
1010 | sub x_resource { |
| 934 | my ($self, $name) = @_; |
1011 | my ($self, $name) = @_; |
| 935 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
1012 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
| 936 | $self->{term}->x_resource ($name) |
1013 | $self->{term}->x_resource ($name) |
| … | |
… | |
| 1071 | $ENV{URXVT_PERL_LIB}, |
1148 | $ENV{URXVT_PERL_LIB}, |
| 1072 | "$ENV{HOME}/.urxvt/ext", |
1149 | "$ENV{HOME}/.urxvt/ext", |
| 1073 | "$LIBDIR/perl" |
1150 | "$LIBDIR/perl" |
| 1074 | } |
1151 | } |
| 1075 | |
1152 | |
| 1076 | sub scan_meta { |
1153 | # scan for available extensions and collect their metadata |
|
|
1154 | sub scan_extensions { |
| 1077 | my ($self) = @_; |
1155 | my ($self) = @_; |
|
|
1156 | |
|
|
1157 | return if exists $self->{meta}; |
|
|
1158 | |
| 1078 | my @libdirs = perl_libdirs $self; |
1159 | my @urxvtdirs = perl_libdirs $self; |
|
|
1160 | # my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC; |
| 1079 | |
1161 | |
| 1080 | return if $self->{meta_libdirs} eq join "\x00", @libdirs; |
|
|
| 1081 | |
|
|
| 1082 | my %meta; |
|
|
| 1083 | |
|
|
| 1084 | $self->{meta_libdirs} = join "\x00", @libdirs; |
|
|
| 1085 | $self->{meta} = \%meta; |
1162 | $self->{meta} = \my %meta; |
| 1086 | |
1163 | |
| 1087 | for my $dir (reverse @libdirs) { |
1164 | # first gather extensions |
|
|
1165 | |
|
|
1166 | my $gather = sub { |
|
|
1167 | my ($dir, $core) = @_; |
|
|
1168 | |
| 1088 | opendir my $fh, $dir |
1169 | opendir my $fh, $dir |
| 1089 | or next; |
1170 | or return; |
|
|
1171 | |
| 1090 | for my $ext (readdir $fh) { |
1172 | for my $ext (readdir $fh) { |
| 1091 | $ext !~ /^\./ |
1173 | $ext !~ /^\./ |
| 1092 | and open my $fh, "<", "$dir/$ext" |
|
|
| 1093 | or next; |
1174 | or next; |
| 1094 | |
1175 | |
|
|
1176 | open my $fh, "<", "$dir/$ext" |
|
|
1177 | or next; |
|
|
1178 | |
|
|
1179 | -f $fh |
|
|
1180 | or next; |
|
|
1181 | |
|
|
1182 | $ext =~ s/\.uext$// or $core |
|
|
1183 | or next; |
|
|
1184 | |
|
|
1185 | my %ext = (dir => $dir); |
|
|
1186 | |
| 1095 | while (<$fh>) { |
1187 | while (<$fh>) { |
| 1096 | if (/^#:META:X_RESOURCE:(.*)/) { |
1188 | if (/^#:META:(?:X_)?RESOURCE:(.*)/) { |
| 1097 | my ($pattern, $type, $desc) = split /:/, $1; |
1189 | my ($pattern, $type, $desc) = split /:/, $1; |
| 1098 | $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name |
1190 | $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name |
| 1099 | if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { |
1191 | if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { |
| 1100 | warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n"; |
1192 | warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n"; |
| 1101 | } else { |
1193 | } else { |
| 1102 | $meta{resource}{$pattern} = [$ext, $type, $desc]; |
1194 | $ext{resource}{$pattern} = [$ext, $type, $desc]; |
| 1103 | } |
1195 | } |
| 1104 | } elsif (/^\s*(?:#|$)/) { |
1196 | } elsif (/^\s*(?:#|$)/) { |
| 1105 | # skip other comments and empty lines |
1197 | # skip other comments and empty lines |
| 1106 | } else { |
1198 | } else { |
| 1107 | last; # stop parsing on first non-empty non-comment line |
1199 | last; # stop parsing on first non-empty non-comment line |
| 1108 | } |
1200 | } |
| 1109 | } |
1201 | } |
|
|
1202 | |
|
|
1203 | $meta{ext}{$ext} = \%ext; |
| 1110 | } |
1204 | } |
|
|
1205 | }; |
|
|
1206 | |
|
|
1207 | # $gather->($_, 0) for @cpandirs; |
|
|
1208 | $gather->($_, 1) for @urxvtdirs; |
|
|
1209 | |
|
|
1210 | # and now merge resources |
|
|
1211 | |
|
|
1212 | $meta{resource} = \my %resource; |
|
|
1213 | |
|
|
1214 | while (my ($k, $v) = each %{ $meta{ext} }) { |
|
|
1215 | #TODO: should check for extensions overriding each other |
|
|
1216 | %resource = (%resource, %{ $v->{resource} }); |
| 1111 | } |
1217 | } |
| 1112 | } |
1218 | } |
| 1113 | |
1219 | |
| 1114 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
1220 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
| 1115 | |
1221 | |
| … | |
… | |
| 1231 | Returns the X-Resource for the given pattern, excluding the program or |
1337 | Returns the X-Resource for the given pattern, excluding the program or |
| 1232 | class name, i.e. C<< $term->x_resource ("boldFont") >> should return the |
1338 | class name, i.e. C<< $term->x_resource ("boldFont") >> should return the |
| 1233 | same value as used by this instance of rxvt-unicode. Returns C<undef> if no |
1339 | same value as used by this instance of rxvt-unicode. Returns C<undef> if no |
| 1234 | resource with that pattern exists. |
1340 | resource with that pattern exists. |
| 1235 | |
1341 | |
| 1236 | Extensions that define extra resource or command line arguments also need |
1342 | Extensions that define extra resources also need to call this method |
| 1237 | to call this method to access their values. |
1343 | to access their values. |
| 1238 | |
1344 | |
| 1239 | If the method is called on an extension object (basically, from an |
1345 | If the method is called on an extension object (basically, from an |
| 1240 | extension), then the special prefix C<%.> will be replaced by the name of |
1346 | extension), then the special prefix C<%.> will be replaced by the name of |
| 1241 | the extension and a dot, and the lone string C<%> will be replaced by the |
1347 | the extension and a dot, and the lone string C<%> will be replaced by the |
| 1242 | extension name itself. This makes it possible to code extensions so you |
1348 | extension name itself. This makes it possible to code extensions so you |
| 1243 | can rename them and get a new set of commandline switches and resources |
1349 | can rename them and get a new set of resources without having to change |
| 1244 | without having to change the actual code. |
1350 | the actual code. |
| 1245 | |
1351 | |
| 1246 | This method should only be called during the C<on_start> hook, as there is |
1352 | This method should only be called during the C<on_start> hook, as there is |
| 1247 | only one resource database per display, and later invocations might return |
1353 | only one resource database per display, and later invocations might return |
| 1248 | the wrong resources. |
1354 | the wrong resources. |
| 1249 | |
1355 | |
| … | |
… | |
| 1261 | my $res = &x_resource; |
1367 | my $res = &x_resource; |
| 1262 | |
1368 | |
| 1263 | $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0 |
1369 | $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0 |
| 1264 | } |
1370 | } |
| 1265 | |
1371 | |
| 1266 | =item $success = $term->parse_keysym ($key, $octets) |
1372 | =item $action = $term->lookup_keysym ($keysym, $state) |
| 1267 | |
1373 | |
|
|
1374 | Returns the action bound to key combination C<($keysym, $state)>, |
|
|
1375 | if a binding for it exists, and C<undef> otherwise. |
|
|
1376 | |
|
|
1377 | =item $success = $term->bind_action ($key, $action) |
|
|
1378 | |
| 1268 | Adds a key binding exactly as specified via a resource. See the |
1379 | Adds a key binding exactly as specified via a C<keysym> resource. See the |
| 1269 | C<keysym> resource in the urxvt(1) manpage. |
1380 | C<keysym> resource in the urxvt(1) manpage. |
| 1270 | |
1381 | |
| 1271 | =item $term->register_command ($keysym, $modifiermask, $string) |
1382 | To add default bindings for actions, an extension should call C<< |
|
|
1383 | ->bind_action >> in its C<init> hook for every such binding. Doing it |
|
|
1384 | in the C<init> hook allows users to override or remove the binding |
|
|
1385 | again. |
| 1272 | |
1386 | |
| 1273 | Adds a key binding. This is a lower level api compared to |
1387 | Example: the C<searchable-scrollback> by default binds itself |
| 1274 | C<parse_keysym>, as it expects a parsed key description, and can be |
1388 | on C<Meta-s>, using C<< $self->bind_action >>, which calls C<< |
| 1275 | used only inside either the C<on_init> hook, to add a binding, or the |
1389 | $term->bind_action >>. |
| 1276 | C<on_register_command> hook, to modify a parsed binding. |
1390 | |
|
|
1391 | sub init { |
|
|
1392 | my ($self) = @_; |
|
|
1393 | |
|
|
1394 | $self->bind_action ("M-s" => "%:start"); |
|
|
1395 | } |
| 1277 | |
1396 | |
| 1278 | =item $rend = $term->rstyle ([$new_rstyle]) |
1397 | =item $rend = $term->rstyle ([$new_rstyle]) |
| 1279 | |
1398 | |
| 1280 | Return and optionally change the current rendition. Text that is output by |
1399 | Return and optionally change the current rendition. Text that is output by |
| 1281 | the terminal application will use this style. |
1400 | the terminal application will use this style. |
| … | |
… | |
| 1439 | |
1558 | |
| 1440 | =item $term->scr_add_lines ($string) |
1559 | =item $term->scr_add_lines ($string) |
| 1441 | |
1560 | |
| 1442 | Write the given text string to the screen, as if output by the application |
1561 | Write the given text string to the screen, as if output by the application |
| 1443 | running inside the terminal. It may not contain command sequences (escape |
1562 | running inside the terminal. It may not contain command sequences (escape |
| 1444 | codes), but is free to use line feeds, carriage returns and tabs. The |
1563 | codes - see C<cmd_parse> for that), but is free to use line feeds, |
| 1445 | string is a normal text string, not in locale-dependent encoding. |
1564 | carriage returns and tabs. The string is a normal text string, not in |
|
|
1565 | locale-dependent encoding. |
| 1446 | |
1566 | |
| 1447 | Normally its not a good idea to use this function, as programs might be |
1567 | Normally its not a good idea to use this function, as programs might be |
| 1448 | confused by changes in cursor position or scrolling. Its useful inside a |
1568 | confused by changes in cursor position or scrolling. Its useful inside a |
| 1449 | C<on_add_lines> hook, though. |
1569 | C<on_add_lines> hook, though. |
| 1450 | |
1570 | |
| … | |
… | |
| 1458 | locale-specific encoding of the terminal and can contain command sequences |
1578 | locale-specific encoding of the terminal and can contain command sequences |
| 1459 | (escape codes) that will be interpreted. |
1579 | (escape codes) that will be interpreted. |
| 1460 | |
1580 | |
| 1461 | =item $term->tt_write ($octets) |
1581 | =item $term->tt_write ($octets) |
| 1462 | |
1582 | |
| 1463 | Write the octets given in C<$octets> to the tty (i.e. as program input). To |
1583 | Write the octets given in C<$octets> to the tty (i.e. as user input |
|
|
1584 | to the program, see C<cmd_parse> for the opposite direction). To pass |
| 1464 | pass characters instead of octets, you should convert your strings first |
1585 | characters instead of octets, you should convert your strings first to the |
| 1465 | to the locale-specific encoding using C<< $term->locale_encode >>. |
1586 | locale-specific encoding using C<< $term->locale_encode >>. |
|
|
1587 | |
|
|
1588 | =item $term->tt_write_user_input ($octets) |
|
|
1589 | |
|
|
1590 | Like C<tt_write>, but should be used when writing strings in response to |
|
|
1591 | the user pressing a key, to invoke the additional actions requested by |
|
|
1592 | the user for that case (C<tt_write> doesn't do that). |
|
|
1593 | |
|
|
1594 | The typical use case would be inside C<on_action> hooks. |
| 1466 | |
1595 | |
| 1467 | =item $term->tt_paste ($octets) |
1596 | =item $term->tt_paste ($octets) |
| 1468 | |
1597 | |
| 1469 | Write the octets given in C<$octets> to the tty as a paste, converting NL to |
1598 | Write the octets given in C<$octets> to the tty as a paste, converting NL to |
| 1470 | CR and bracketing the data with control sequences if bracketed paste mode |
1599 | CR and bracketing the data with control sequences if bracketed paste mode |
| … | |
… | |
| 1509 | |
1638 | |
| 1510 | =item $term->key_release ($state, $keycode[, $time]) |
1639 | =item $term->key_release ($state, $keycode[, $time]) |
| 1511 | |
1640 | |
| 1512 | Deliver various fake events to to terminal. |
1641 | Deliver various fake events to to terminal. |
| 1513 | |
1642 | |
| 1514 | =item $window_width = $term->width |
1643 | =item $window_width = $term->width ([$new_value]) |
| 1515 | |
1644 | |
| 1516 | =item $window_height = $term->height |
1645 | =item $window_height = $term->height ([$new_value]) |
| 1517 | |
1646 | |
| 1518 | =item $font_width = $term->fwidth |
1647 | =item $font_width = $term->fwidth ([$new_value]) |
| 1519 | |
1648 | |
| 1520 | =item $font_height = $term->fheight |
1649 | =item $font_height = $term->fheight ([$new_value]) |
| 1521 | |
1650 | |
| 1522 | =item $font_ascent = $term->fbase |
1651 | =item $font_ascent = $term->fbase ([$new_value]) |
| 1523 | |
1652 | |
| 1524 | =item $terminal_rows = $term->nrow |
1653 | =item $terminal_rows = $term->nrow ([$new_value]) |
| 1525 | |
1654 | |
| 1526 | =item $terminal_columns = $term->ncol |
1655 | =item $terminal_columns = $term->ncol ([$new_value]) |
| 1527 | |
1656 | |
| 1528 | =item $has_focus = $term->focus |
1657 | =item $has_focus = $term->focus ([$new_value]) |
| 1529 | |
1658 | |
| 1530 | =item $is_mapped = $term->mapped |
1659 | =item $is_mapped = $term->mapped ([$new_value]) |
| 1531 | |
1660 | |
| 1532 | =item $max_scrollback = $term->saveLines |
1661 | =item $max_scrollback = $term->saveLines ([$new_value]) |
| 1533 | |
1662 | |
| 1534 | =item $nrow_plus_saveLines = $term->total_rows |
1663 | =item $nrow_plus_saveLines = $term->total_rows ([$new_value]) |
| 1535 | |
1664 | |
| 1536 | =item $topmost_scrollback_row = $term->top_row |
1665 | =item $topmost_scrollback_row = $term->top_row ([$new_value]) |
| 1537 | |
1666 | |
| 1538 | Return various integers describing terminal characteristics. |
1667 | Return various integers describing terminal characteristics. If an |
|
|
1668 | argument is given, changes the value and returns the previous one. |
| 1539 | |
1669 | |
| 1540 | =item $x_display = $term->display_id |
1670 | =item $x_display = $term->display_id |
| 1541 | |
1671 | |
| 1542 | Return the DISPLAY used by rxvt-unicode. |
1672 | Return the DISPLAY used by rxvt-unicode. |
| 1543 | |
1673 | |
| … | |
… | |
| 1579 | Returns the currently displayed screen (0 primary, 1 secondary). |
1709 | Returns the currently displayed screen (0 primary, 1 secondary). |
| 1580 | |
1710 | |
| 1581 | =item $cursor_is_hidden = $term->hidden_cursor |
1711 | =item $cursor_is_hidden = $term->hidden_cursor |
| 1582 | |
1712 | |
| 1583 | Returns whether the cursor is currently hidden or not. |
1713 | Returns whether the cursor is currently hidden or not. |
|
|
1714 | |
|
|
1715 | =item $priv_modes = $term->priv_modes |
|
|
1716 | |
|
|
1717 | Returns a bitset with the state of DEC private modes. |
|
|
1718 | |
|
|
1719 | Example: |
|
|
1720 | |
|
|
1721 | if ($term->priv_modes & urxvt::PrivMode_mouse_report) { |
|
|
1722 | # mouse reporting is turned on |
|
|
1723 | } |
| 1584 | |
1724 | |
| 1585 | =item $view_start = $term->view_start ([$newvalue]) |
1725 | =item $view_start = $term->view_start ([$newvalue]) |
| 1586 | |
1726 | |
| 1587 | Returns the row number of the topmost displayed line. Maximum value is |
1727 | Returns the row number of the topmost displayed line. Maximum value is |
| 1588 | C<0>, which displays the normal terminal contents. Lower values scroll |
1728 | C<0>, which displays the normal terminal contents. Lower values scroll |
| … | |
… | |
| 1593 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
1733 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
| 1594 | compare the on-screen display with its stored representation. If they |
1734 | compare the on-screen display with its stored representation. If they |
| 1595 | differ, it redraws the differences. |
1735 | differ, it redraws the differences. |
| 1596 | |
1736 | |
| 1597 | Used after changing terminal contents to display them. |
1737 | Used after changing terminal contents to display them. |
|
|
1738 | |
|
|
1739 | =item $term->refresh_check |
|
|
1740 | |
|
|
1741 | Checks if a refresh has been requested and, if so, schedules one. |
| 1598 | |
1742 | |
| 1599 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1743 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
| 1600 | |
1744 | |
| 1601 | Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> |
1745 | Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> |
| 1602 | is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost |
1746 | is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost |
