| … | |
… | |
| 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. |
|
|
121 | |
|
|
122 | Currently, it recognises only one such comment: |
|
|
123 | |
|
|
124 | =over 4 |
|
|
125 | |
|
|
126 | =item #:META:RESOURCE:name:type:desc |
|
|
127 | |
|
|
128 | The RESOURCE comment defines a resource used by the extension, where |
|
|
129 | C<name> is the resource name, C<type> is the resource type, C<boolean> |
|
|
130 | or C<string>, and C<desc> is the resource description. |
|
|
131 | |
|
|
132 | =back |
|
|
133 | |
| 111 | =head2 Hooks |
134 | =head2 Hooks |
| 112 | |
135 | |
| 113 | The following subroutines can be declared in extension files, and will be |
136 | The following subroutines can be declared in extension files, and will be |
| 114 | called whenever the relevant event happens. |
137 | called whenever the relevant event happens. |
| 115 | |
138 | |
| … | |
… | |
| 281 | |
304 | |
| 282 | =item on_refresh_end $term |
305 | =item on_refresh_end $term |
| 283 | |
306 | |
| 284 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
307 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
| 285 | |
308 | |
|
|
309 | =item on_action $term, $string |
|
|
310 | |
|
|
311 | Called whenever an action is invoked for the corresponding extension |
|
|
312 | (e.g. via a C<extension:string> builtin action bound to a key, see |
|
|
313 | description of the B<keysym> resource in the urxvt(1) manpage). The |
|
|
314 | event is simply the action string. Note that an action event is always |
|
|
315 | associated to a single extension. |
|
|
316 | |
| 286 | =item on_user_command $term, $string *DEPRECATED* |
317 | =item on_user_command $term, $string *DEPRECATED* |
| 287 | |
318 | |
| 288 | Called whenever a user-configured event is being activated (e.g. via |
319 | 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> |
320 | a C<perl:string> action bound to a key, see description of the B<keysym> |
| 290 | resource in the urxvt(1) manpage). |
321 | resource in the urxvt(1) manpage). |
| 291 | |
322 | |
| 292 | The event is simply the action string. This interface is going away in |
323 | The event is simply the action string. This interface is going away in |
| 293 | preference to the C<< ->register_keysym_action >> method. |
324 | 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 | |
325 | |
| 302 | =item on_resize_all_windows $term, $new_width, $new_height |
326 | =item on_resize_all_windows $term, $new_width, $new_height |
| 303 | |
327 | |
| 304 | Called just after the new window size has been calculated, but before |
328 | 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 |
329 | 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 |
374 | 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. |
375 | (real, not screen-based) row and column under the mouse cursor. |
| 352 | |
376 | |
| 353 | C<on_key_press> additionally receives the string rxvt-unicode would |
377 | C<on_key_press> additionally receives the string rxvt-unicode would |
| 354 | output, if any, in locale-specific encoding. |
378 | output, if any, in locale-specific encoding. |
| 355 | |
|
|
| 356 | subwindow. |
|
|
| 357 | |
379 | |
| 358 | =item on_client_message $term, $event |
380 | =item on_client_message $term, $event |
| 359 | |
381 | |
| 360 | =item on_wm_protocols $term, $event |
382 | =item on_wm_protocols $term, $event |
| 361 | |
383 | |
| … | |
… | |
| 564 | no warnings 'utf8'; |
586 | no warnings 'utf8'; |
| 565 | |
587 | |
| 566 | sub parse_resource { |
588 | sub parse_resource { |
| 567 | my ($term, $name, $isarg, $longopt, $flag, $value) = @_; |
589 | my ($term, $name, $isarg, $longopt, $flag, $value) = @_; |
| 568 | |
590 | |
| 569 | $name =~ y/-/./ if $isarg; |
|
|
| 570 | |
|
|
| 571 | $term->scan_meta; |
591 | $term->scan_extensions; |
| 572 | |
592 | |
| 573 | my $r = $term->{meta}{resource}; |
593 | my $r = $term->{meta}{resource}; |
| 574 | keys %$r; # reset iterator |
594 | keys %$r; # reset iterator |
| 575 | while (my ($pattern, $v) = each %$r) { |
595 | while (my ($k, $v) = each %$r) { |
| 576 | if ( |
596 | my $pattern = $k; |
|
|
597 | $pattern =~ y/./-/ if $isarg; |
|
|
598 | my $prefix = $name; |
|
|
599 | my $suffix; |
| 577 | $pattern =~ /\.$/ |
600 | if ($pattern =~ /\-$/) { |
| 578 | ? $pattern eq substr $name, 0, length $pattern |
601 | $prefix = substr $name, 0, length $pattern; |
| 579 | : $pattern eq $name |
602 | $suffix = substr $name, length $pattern; |
| 580 | ) { |
603 | } |
|
|
604 | if ($pattern eq $prefix) { |
| 581 | $name = "$urxvt::RESCLASS.$name"; |
605 | $name = "$urxvt::RESCLASS.$k$suffix"; |
| 582 | |
606 | |
| 583 | push @{ $term->{perl_ext_3} }, $v->[0]; |
607 | push @{ $term->{perl_ext_3} }, $v->[0]; |
| 584 | |
608 | |
| 585 | if ($v->[1] eq "boolean") { |
609 | if ($v->[1] eq "boolean") { |
| 586 | $term->put_option_db ($name, $flag ? "true" : "false"); |
610 | $term->put_option_db ($name, $flag ? "true" : "false"); |
| … | |
… | |
| 596 | } |
620 | } |
| 597 | |
621 | |
| 598 | sub usage { |
622 | sub usage { |
| 599 | my ($term, $usage_type) = @_; |
623 | my ($term, $usage_type) = @_; |
| 600 | |
624 | |
| 601 | $term->scan_meta; |
625 | $term->scan_extensions; |
| 602 | |
626 | |
| 603 | my $r = $term->{meta}{resource}; |
627 | my $r = $term->{meta}{resource}; |
| 604 | |
628 | |
| 605 | for my $pattern (sort keys %$r) { |
629 | for my $pattern (sort keys %$r) { |
| 606 | my ($ext, $type, $desc) = @{ $r->{$pattern} }; |
630 | my ($ext, $type, $desc) = @{ $r->{$pattern} }; |
| … | |
… | |
| 667 | # called by the rxvt core |
691 | # called by the rxvt core |
| 668 | sub invoke { |
692 | sub invoke { |
| 669 | local $TERM = shift; |
693 | local $TERM = shift; |
| 670 | my $htype = shift; |
694 | my $htype = shift; |
| 671 | |
695 | |
| 672 | if ($htype == 0) { # INIT |
696 | if ($htype == HOOK_INIT) { |
| 673 | my @dirs = $TERM->perl_libdirs; |
697 | my @dirs = $TERM->perl_libdirs; |
|
|
698 | |
|
|
699 | $TERM->scan_extensions; |
| 674 | |
700 | |
| 675 | my %ext_arg; |
701 | my %ext_arg; |
| 676 | |
702 | |
| 677 | { |
703 | { |
| 678 | my @init = @TERM_INIT; |
704 | my @init = @TERM_INIT; |
| … | |
… | |
| 682 | @TERM_EXT = (); |
708 | @TERM_EXT = (); |
| 683 | $TERM->register_package ($_) for @pkg; |
709 | $TERM->register_package ($_) for @pkg; |
| 684 | } |
710 | } |
| 685 | |
711 | |
| 686 | for ( |
712 | for ( |
|
|
713 | (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2), |
| 687 | @{ delete $TERM->{perl_ext_3} }, |
714 | @{ delete $TERM->{perl_ext_3} } |
| 688 | grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2 |
|
|
| 689 | ) { |
715 | ) { |
| 690 | if ($_ eq "default") { |
716 | if ($_ eq "default") { |
|
|
717 | |
|
|
718 | $ext_arg{$_} = [] |
| 691 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
719 | for qw(selection option-popup selection-popup readline searchable-scrollback); |
|
|
720 | |
|
|
721 | for ($TERM->_keysym_resources) { |
|
|
722 | next if /^(?:string|command|builtin|builtin-string|perl)/; |
|
|
723 | next unless /^([A-Za-z0-9_\-]+):/; |
|
|
724 | |
|
|
725 | my $ext = $1; |
|
|
726 | |
|
|
727 | $ext_arg{$ext} = []; |
|
|
728 | } |
|
|
729 | |
| 692 | } elsif (/^-(.*)$/) { |
730 | } elsif (/^-(.*)$/) { |
| 693 | delete $ext_arg{$1}; |
731 | delete $ext_arg{$1}; |
|
|
732 | |
| 694 | } elsif (/^([^<]+)<(.*)>$/) { |
733 | } elsif (/^([^<]+)<(.*)>$/) { |
| 695 | push @{ $ext_arg{$1} }, $2; |
734 | push @{ $ext_arg{$1} }, $2; |
|
|
735 | |
| 696 | } else { |
736 | } else { |
| 697 | $ext_arg{$_} ||= []; |
737 | $ext_arg{$_} ||= []; |
| 698 | } |
738 | } |
| 699 | } |
739 | } |
| 700 | |
740 | |
| … | |
… | |
| 716 | |
756 | |
| 717 | if (my $cb = $TERM->{_hook}[$htype]) { |
757 | if (my $cb = $TERM->{_hook}[$htype]) { |
| 718 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
758 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
| 719 | if $verbosity >= 10; |
759 | if $verbosity >= 10; |
| 720 | |
760 | |
|
|
761 | if ($htype == HOOK_ACTION) { |
|
|
762 | # this hook is only sent to the extension with the name |
|
|
763 | # matching the first arg |
|
|
764 | my $pkg = shift; |
|
|
765 | $pkg =~ y/-/_/; |
|
|
766 | $pkg = "urxvt::ext::$pkg"; |
|
|
767 | |
|
|
768 | $cb = $cb->{$pkg} |
|
|
769 | or return undef; #TODO: maybe warn user? |
|
|
770 | |
|
|
771 | $cb = { $pkg => $cb }; |
|
|
772 | } |
|
|
773 | |
| 721 | for my $pkg (keys %$cb) { |
774 | for my $pkg (keys %$cb) { |
| 722 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) }; |
775 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) }; |
| 723 | $retval ||= $retval_; |
776 | $retval ||= $retval_; |
| 724 | |
777 | |
| 725 | if ($@) { |
778 | if ($@) { |
| … | |
… | |
| 730 | |
783 | |
| 731 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
784 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
| 732 | if $verbosity >= 11; |
785 | if $verbosity >= 11; |
| 733 | } |
786 | } |
| 734 | |
787 | |
| 735 | if ($htype == 1) { # DESTROY |
788 | if ($htype == HOOK_DESTROY) { |
| 736 | # clear package objects |
789 | # clear package objects |
| 737 | %$_ = () for values %{ $TERM->{_pkg} }; |
790 | %$_ = () for values %{ $TERM->{_pkg} }; |
| 738 | |
791 | |
| 739 | # clear package |
792 | # clear package |
| 740 | %$TERM = (); |
793 | %$TERM = (); |
| … | |
… | |
| 912 | } |
965 | } |
| 913 | |
966 | |
| 914 | bless \%disable, "urxvt::extension::on_disable" |
967 | bless \%disable, "urxvt::extension::on_disable" |
| 915 | } |
968 | } |
| 916 | |
969 | |
|
|
970 | =item $self->bind_action ($hotkey, $action) |
|
|
971 | |
| 917 | =item $self->x_resource ($pattern) |
972 | =item $self->x_resource ($pattern) |
| 918 | |
973 | |
| 919 | =item $self->x_resource_boolean ($pattern) |
974 | =item $self->x_resource_boolean ($pattern) |
| 920 | |
975 | |
| 921 | These methods support an additional C<%> prefix when called on an |
976 | These methods support an additional C<%> prefix for C<$action> or |
| 922 | extension object - see the description of these methods in the |
977 | C<$pattern> when called on an extension object, compared to the |
|
|
978 | C<urxvt::term> methods of the same name - see the description of these |
| 923 | C<urxvt::term> class for details. |
979 | methods in the C<urxvt::term> class for details. |
| 924 | |
980 | |
| 925 | =cut |
981 | =cut |
|
|
982 | |
|
|
983 | sub bind_action { |
|
|
984 | my ($self, $hotkey, $action) = @_; |
|
|
985 | $action =~ s/^%:/$_[0]{_name}:/; |
|
|
986 | $self->{term}->bind_action ($hotkey, $action) |
|
|
987 | } |
| 926 | |
988 | |
| 927 | sub x_resource { |
989 | sub x_resource { |
| 928 | my ($self, $name) = @_; |
990 | my ($self, $name) = @_; |
| 929 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
991 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
| 930 | $self->{term}->x_resource ($name) |
992 | $self->{term}->x_resource ($name) |
| … | |
… | |
| 1065 | $ENV{URXVT_PERL_LIB}, |
1127 | $ENV{URXVT_PERL_LIB}, |
| 1066 | "$ENV{HOME}/.urxvt/ext", |
1128 | "$ENV{HOME}/.urxvt/ext", |
| 1067 | "$LIBDIR/perl" |
1129 | "$LIBDIR/perl" |
| 1068 | } |
1130 | } |
| 1069 | |
1131 | |
| 1070 | sub scan_meta { |
1132 | # scan for available extensions and collect their metadata |
|
|
1133 | sub scan_extensions { |
| 1071 | my ($self) = @_; |
1134 | my ($self) = @_; |
|
|
1135 | |
|
|
1136 | return if exists $self->{meta}; |
|
|
1137 | |
| 1072 | my @libdirs = perl_libdirs $self; |
1138 | my @urxvtdirs = perl_libdirs $self; |
|
|
1139 | # my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC; |
| 1073 | |
1140 | |
| 1074 | return if $self->{meta_libdirs} eq join "\x00", @libdirs; |
|
|
| 1075 | |
|
|
| 1076 | my %meta; |
|
|
| 1077 | |
|
|
| 1078 | $self->{meta_libdirs} = join "\x00", @libdirs; |
|
|
| 1079 | $self->{meta} = \%meta; |
1141 | $self->{meta} = \my %meta; |
| 1080 | |
1142 | |
| 1081 | for my $dir (reverse @libdirs) { |
1143 | # first gather extensions |
|
|
1144 | |
|
|
1145 | my $gather = sub { |
|
|
1146 | my ($dir, $core) = @_; |
|
|
1147 | |
| 1082 | opendir my $fh, $dir |
1148 | opendir my $fh, $dir |
| 1083 | or next; |
1149 | or return; |
|
|
1150 | |
| 1084 | for my $ext (readdir $fh) { |
1151 | for my $ext (readdir $fh) { |
| 1085 | $ext !~ /^\./ |
1152 | $ext !~ /^\./ |
| 1086 | and open my $fh, "<", "$dir/$ext" |
|
|
| 1087 | or next; |
1153 | or next; |
| 1088 | |
1154 | |
|
|
1155 | open my $fh, "<", "$dir/$ext" |
|
|
1156 | or next; |
|
|
1157 | |
|
|
1158 | -f $fh |
|
|
1159 | or next; |
|
|
1160 | |
|
|
1161 | $ext =~ s/\.uext$// or $core |
|
|
1162 | or next; |
|
|
1163 | |
|
|
1164 | my %ext = (dir => $dir); |
|
|
1165 | |
| 1089 | while (<$fh>) { |
1166 | while (<$fh>) { |
| 1090 | if (/^#:META:X_RESOURCE:(.*)/) { |
1167 | if (/^#:META:(?:X_)?RESOURCE:(.*)/) { |
| 1091 | my ($pattern, $type, $desc) = split /:/, $1; |
1168 | my ($pattern, $type, $desc) = split /:/, $1; |
| 1092 | $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name |
1169 | $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name |
| 1093 | if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { |
1170 | if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { |
| 1094 | warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n"; |
1171 | warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n"; |
| 1095 | } else { |
1172 | } else { |
| 1096 | $meta{resource}{$pattern} = [$ext, $type, $desc]; |
1173 | $ext{resource}{$pattern} = [$ext, $type, $desc]; |
| 1097 | } |
1174 | } |
| 1098 | } elsif (/^\s*(?:#|$)/) { |
1175 | } elsif (/^\s*(?:#|$)/) { |
| 1099 | # skip other comments and empty lines |
1176 | # skip other comments and empty lines |
| 1100 | } else { |
1177 | } else { |
| 1101 | last; # stop parsing on first non-empty non-comment line |
1178 | last; # stop parsing on first non-empty non-comment line |
| 1102 | } |
1179 | } |
| 1103 | } |
1180 | } |
|
|
1181 | |
|
|
1182 | $meta{ext}{$ext} = \%ext; |
| 1104 | } |
1183 | } |
|
|
1184 | }; |
|
|
1185 | |
|
|
1186 | # $gather->($_, 0) for @cpandirs; |
|
|
1187 | $gather->($_, 1) for @urxvtdirs; |
|
|
1188 | |
|
|
1189 | # and now merge resources |
|
|
1190 | |
|
|
1191 | $meta{resource} = \my %resource; |
|
|
1192 | |
|
|
1193 | while (my ($k, $v) = each %{ $meta{ext} }) { |
|
|
1194 | #TODO: should check for extensions overriding each other |
|
|
1195 | %resource = (%resource, %{ $v->{resource} }); |
| 1105 | } |
1196 | } |
| 1106 | } |
1197 | } |
| 1107 | |
1198 | |
| 1108 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
1199 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
| 1109 | |
1200 | |
| … | |
… | |
| 1225 | Returns the X-Resource for the given pattern, excluding the program or |
1316 | Returns the X-Resource for the given pattern, excluding the program or |
| 1226 | class name, i.e. C<< $term->x_resource ("boldFont") >> should return the |
1317 | class name, i.e. C<< $term->x_resource ("boldFont") >> should return the |
| 1227 | same value as used by this instance of rxvt-unicode. Returns C<undef> if no |
1318 | same value as used by this instance of rxvt-unicode. Returns C<undef> if no |
| 1228 | resource with that pattern exists. |
1319 | resource with that pattern exists. |
| 1229 | |
1320 | |
| 1230 | Extensions that define extra resource or command line arguments also need |
1321 | Extensions that define extra resources also need to call this method |
| 1231 | to call this method to access their values. |
1322 | to access their values. |
| 1232 | |
1323 | |
| 1233 | If the method is called on an extension object (basically, from an |
1324 | If the method is called on an extension object (basically, from an |
| 1234 | extension), then the special prefix C<%.> will be replaced by the name of |
1325 | extension), then the special prefix C<%.> will be replaced by the name of |
| 1235 | the extension and a dot, and the lone string C<%> will be replaced by the |
1326 | the extension and a dot, and the lone string C<%> will be replaced by the |
| 1236 | extension name itself. This makes it possible to code extensions so you |
1327 | extension name itself. This makes it possible to code extensions so you |
| 1237 | can rename them and get a new set of commandline switches and resources |
1328 | can rename them and get a new set of resources without having to change |
| 1238 | without having to change the actual code. |
1329 | the actual code. |
| 1239 | |
1330 | |
| 1240 | This method should only be called during the C<on_start> hook, as there is |
1331 | This method should only be called during the C<on_start> hook, as there is |
| 1241 | only one resource database per display, and later invocations might return |
1332 | only one resource database per display, and later invocations might return |
| 1242 | the wrong resources. |
1333 | the wrong resources. |
| 1243 | |
1334 | |
| … | |
… | |
| 1255 | my $res = &x_resource; |
1346 | my $res = &x_resource; |
| 1256 | |
1347 | |
| 1257 | $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0 |
1348 | $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0 |
| 1258 | } |
1349 | } |
| 1259 | |
1350 | |
| 1260 | =item $success = $term->parse_keysym ($key, $octets) |
1351 | =item $action = $term->lookup_keysym ($keysym, $state) |
| 1261 | |
1352 | |
|
|
1353 | Returns the action bound to key combination C<($keysym, $state)>, |
|
|
1354 | if a binding for it exists, and C<undef> otherwise. |
|
|
1355 | |
|
|
1356 | =item $success = $term->bind_action ($key, $action) |
|
|
1357 | |
| 1262 | Adds a key binding exactly as specified via a resource. See the |
1358 | Adds a key binding exactly as specified via a C<keysym> resource. See the |
| 1263 | C<keysym> resource in the urxvt(1) manpage. |
1359 | C<keysym> resource in the urxvt(1) manpage. |
| 1264 | |
1360 | |
| 1265 | =item $term->register_command ($keysym, $modifiermask, $string) |
1361 | To add default bindings for actions, an extension should call C<< |
|
|
1362 | ->bind_action >> in its C<init> hook for every such binding. Doing it |
|
|
1363 | in the C<init> hook allows users to override or remove the binding |
|
|
1364 | again. |
| 1266 | |
1365 | |
| 1267 | Adds a key binding. This is a lower level api compared to |
1366 | Example: the C<searchable-scrollback> by default binds itself |
| 1268 | C<parse_keysym>, as it expects a parsed key description, and can be |
1367 | on C<Meta-s>, using C<< $self->bind_action >>, which calls C<< |
| 1269 | used only inside either the C<on_init> hook, to add a binding, or the |
1368 | $term->bind_action >>. |
| 1270 | C<on_register_command> hook, to modify a parsed binding. |
1369 | |
|
|
1370 | sub init { |
|
|
1371 | my ($self) = @_; |
|
|
1372 | |
|
|
1373 | $self->bind_action ("M-s" => "%:start"); |
|
|
1374 | } |
| 1271 | |
1375 | |
| 1272 | =item $rend = $term->rstyle ([$new_rstyle]) |
1376 | =item $rend = $term->rstyle ([$new_rstyle]) |
| 1273 | |
1377 | |
| 1274 | Return and optionally change the current rendition. Text that is output by |
1378 | Return and optionally change the current rendition. Text that is output by |
| 1275 | the terminal application will use this style. |
1379 | the terminal application will use this style. |
| … | |
… | |
| 1433 | |
1537 | |
| 1434 | =item $term->scr_add_lines ($string) |
1538 | =item $term->scr_add_lines ($string) |
| 1435 | |
1539 | |
| 1436 | Write the given text string to the screen, as if output by the application |
1540 | Write the given text string to the screen, as if output by the application |
| 1437 | running inside the terminal. It may not contain command sequences (escape |
1541 | running inside the terminal. It may not contain command sequences (escape |
| 1438 | codes), but is free to use line feeds, carriage returns and tabs. The |
1542 | codes - see C<cmd_parse> for that), but is free to use line feeds, |
| 1439 | string is a normal text string, not in locale-dependent encoding. |
1543 | carriage returns and tabs. The string is a normal text string, not in |
|
|
1544 | locale-dependent encoding. |
| 1440 | |
1545 | |
| 1441 | Normally its not a good idea to use this function, as programs might be |
1546 | Normally its not a good idea to use this function, as programs might be |
| 1442 | confused by changes in cursor position or scrolling. Its useful inside a |
1547 | confused by changes in cursor position or scrolling. Its useful inside a |
| 1443 | C<on_add_lines> hook, though. |
1548 | C<on_add_lines> hook, though. |
| 1444 | |
1549 | |
| … | |
… | |
| 1452 | locale-specific encoding of the terminal and can contain command sequences |
1557 | locale-specific encoding of the terminal and can contain command sequences |
| 1453 | (escape codes) that will be interpreted. |
1558 | (escape codes) that will be interpreted. |
| 1454 | |
1559 | |
| 1455 | =item $term->tt_write ($octets) |
1560 | =item $term->tt_write ($octets) |
| 1456 | |
1561 | |
| 1457 | Write the octets given in C<$octets> to the tty (i.e. as program input). To |
1562 | Write the octets given in C<$octets> to the tty (i.e. as user input |
|
|
1563 | to the program, see C<cmd_parse> for the opposite direction). To pass |
| 1458 | pass characters instead of octets, you should convert your strings first |
1564 | characters instead of octets, you should convert your strings first to the |
| 1459 | to the locale-specific encoding using C<< $term->locale_encode >>. |
1565 | locale-specific encoding using C<< $term->locale_encode >>. |
|
|
1566 | |
|
|
1567 | =item $term->tt_write_user_input ($octets) |
|
|
1568 | |
|
|
1569 | Like C<tt_write>, but should be used when writing strings in response to |
|
|
1570 | the user pressing a key, to invoke the additional actions requested by |
|
|
1571 | the user for that case (C<tt_write> doesn't do that). |
|
|
1572 | |
|
|
1573 | The typical use case would be inside C<on_action> hooks. |
| 1460 | |
1574 | |
| 1461 | =item $term->tt_paste ($octets) |
1575 | =item $term->tt_paste ($octets) |
| 1462 | |
1576 | |
| 1463 | Write the octets given in C<$octets> to the tty as a paste, converting NL to |
1577 | Write the octets given in C<$octets> to the tty as a paste, converting NL to |
| 1464 | CR and bracketing the data with control sequences if bracketed paste mode |
1578 | CR and bracketing the data with control sequences if bracketed paste mode |
| … | |
… | |
| 1503 | |
1617 | |
| 1504 | =item $term->key_release ($state, $keycode[, $time]) |
1618 | =item $term->key_release ($state, $keycode[, $time]) |
| 1505 | |
1619 | |
| 1506 | Deliver various fake events to to terminal. |
1620 | Deliver various fake events to to terminal. |
| 1507 | |
1621 | |
| 1508 | =item $window_width = $term->width |
1622 | =item $window_width = $term->width ([$new_value]) |
| 1509 | |
1623 | |
| 1510 | =item $window_height = $term->height |
1624 | =item $window_height = $term->height ([$new_value]) |
| 1511 | |
1625 | |
| 1512 | =item $font_width = $term->fwidth |
1626 | =item $font_width = $term->fwidth ([$new_value]) |
| 1513 | |
1627 | |
| 1514 | =item $font_height = $term->fheight |
1628 | =item $font_height = $term->fheight ([$new_value]) |
| 1515 | |
1629 | |
| 1516 | =item $font_ascent = $term->fbase |
1630 | =item $font_ascent = $term->fbase ([$new_value]) |
| 1517 | |
1631 | |
| 1518 | =item $terminal_rows = $term->nrow |
1632 | =item $terminal_rows = $term->nrow ([$new_value]) |
| 1519 | |
1633 | |
| 1520 | =item $terminal_columns = $term->ncol |
1634 | =item $terminal_columns = $term->ncol ([$new_value]) |
| 1521 | |
1635 | |
| 1522 | =item $has_focus = $term->focus |
1636 | =item $has_focus = $term->focus ([$new_value]) |
| 1523 | |
1637 | |
| 1524 | =item $is_mapped = $term->mapped |
1638 | =item $is_mapped = $term->mapped ([$new_value]) |
| 1525 | |
1639 | |
| 1526 | =item $max_scrollback = $term->saveLines |
1640 | =item $max_scrollback = $term->saveLines ([$new_value]) |
| 1527 | |
1641 | |
| 1528 | =item $nrow_plus_saveLines = $term->total_rows |
1642 | =item $nrow_plus_saveLines = $term->total_rows ([$new_value]) |
| 1529 | |
1643 | |
| 1530 | =item $topmost_scrollback_row = $term->top_row |
1644 | =item $topmost_scrollback_row = $term->top_row ([$new_value]) |
| 1531 | |
1645 | |
| 1532 | Return various integers describing terminal characteristics. |
1646 | Return various integers describing terminal characteristics. If an |
|
|
1647 | argument is given, changes the value and returns the previous one. |
| 1533 | |
1648 | |
| 1534 | =item $x_display = $term->display_id |
1649 | =item $x_display = $term->display_id |
| 1535 | |
1650 | |
| 1536 | Return the DISPLAY used by rxvt-unicode. |
1651 | Return the DISPLAY used by rxvt-unicode. |
| 1537 | |
1652 | |
| … | |
… | |
| 1587 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
1702 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
| 1588 | compare the on-screen display with its stored representation. If they |
1703 | compare the on-screen display with its stored representation. If they |
| 1589 | differ, it redraws the differences. |
1704 | differ, it redraws the differences. |
| 1590 | |
1705 | |
| 1591 | Used after changing terminal contents to display them. |
1706 | Used after changing terminal contents to display them. |
|
|
1707 | |
|
|
1708 | =item $term->refresh_check |
|
|
1709 | |
|
|
1710 | Checks if a refresh has been requested and, if so, schedules one. |
| 1592 | |
1711 | |
| 1593 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1712 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
| 1594 | |
1713 | |
| 1595 | Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> |
1714 | Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> |
| 1596 | is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost |
1715 | is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost |
