… | |
… | |
45 | |
45 | |
46 | URxvt.perl-ext-common: default,selection-autotransform |
46 | URxvt.perl-ext-common: default,selection-autotransform |
47 | |
47 | |
48 | Extensions may add additional resources and C<actions>, i.e., methods |
48 | Extensions may add additional resources and C<actions>, i.e., methods |
49 | which can be bound to a key and invoked by the user. An extension can |
49 | which can be bound to a key and invoked by the user. An extension can |
50 | define the resources it support and also default bindings for one or |
50 | define the resources it support using so called META comments, |
51 | more actions it provides using so called META comments, described |
|
|
52 | below. Similarly to builtin resources, extension resources can also be |
51 | described below. Similarly to builtin resources, extension resources |
53 | specified on the command line as long options (with C<.> replaced by |
52 | can also be specified on the command line as long options (with C<.> |
54 | C<->), in which case the corresponding extension is loaded |
53 | replaced by C<->), in which case the corresponding extension is loaded |
55 | automatically. For this to work the extension B<must> define META |
54 | automatically. For this to work the extension B<must> define META |
56 | comments for its resources. |
55 | comments for its resources. |
57 | |
56 | |
58 | =head1 API DOCUMENTATION |
57 | =head1 API DOCUMENTATION |
59 | |
58 | |
… | |
… | |
115 | Additional methods only supported for extension objects are described in |
114 | Additional methods only supported for extension objects are described in |
116 | the C<urxvt::extension> section below. |
115 | the C<urxvt::extension> section below. |
117 | |
116 | |
118 | =head2 META comments |
117 | =head2 META comments |
119 | |
118 | |
120 | rxvt-unicode recognizes special comments in extensions that define |
119 | Rxvt-unicode recognizes special meta comments in extensions that define |
121 | different types of metadata: |
120 | different types of metadata. |
|
|
121 | |
|
|
122 | Currently, it recognises only one such comment: |
122 | |
123 | |
123 | =over 4 |
124 | =over 4 |
124 | |
125 | |
125 | =item #:META:RESOURCE:name:type:desc |
126 | =item #:META:RESOURCE:name:type:desc |
126 | |
127 | |
127 | The RESOURCE comment defines a resource used by the extension, where |
128 | The RESOURCE comment defines a resource used by the extension, where |
128 | C<name> is the resource name, C<type> is the resource type, C<boolean> |
129 | C<name> is the resource name, C<type> is the resource type, C<boolean> |
129 | or C<string>, and C<desc> is the resource description. |
130 | or C<string>, and C<desc> is the resource description. |
130 | |
|
|
131 | =item #:META:BINDING:sym:action |
|
|
132 | |
|
|
133 | The BINDING comment defines a default binding for an action provided |
|
|
134 | by the extension, where C<sym> is the key combination that triggers |
|
|
135 | the action, whose format is defined in the description of the |
|
|
136 | B<keysym> resource in the urxvt(1) manpage, and C<action> is the name |
|
|
137 | of the action method. |
|
|
138 | |
131 | |
139 | =back |
132 | =back |
140 | |
133 | |
141 | =head2 Hooks |
134 | =head2 Hooks |
142 | |
135 | |
… | |
… | |
721 | @{ delete $TERM->{perl_ext_3} } |
714 | @{ delete $TERM->{perl_ext_3} } |
722 | ) { |
715 | ) { |
723 | if ($_ eq "default") { |
716 | if ($_ eq "default") { |
724 | |
717 | |
725 | $ext_arg{$_} = [] |
718 | $ext_arg{$_} = [] |
726 | for |
|
|
727 | qw(selection option-popup selection-popup readline searchable-scrollback), |
719 | for qw(selection option-popup selection-popup readline searchable-scrollback); |
728 | map $_->[0], values %{ $TERM->{meta}{binding} }; |
|
|
729 | |
720 | |
730 | for ($TERM->_keysym_resources) { |
721 | for ($TERM->_keysym_resources) { |
731 | next if /^(?:string|command|builtin|builtin-string|perl)/; |
722 | next if /^(?:string|command|builtin|builtin-string|perl)/; |
732 | next unless /^([A-Za-z0-9_\-]+):/; |
723 | next unless /^([A-Za-z0-9_\-]+):/; |
733 | |
724 | |
… | |
… | |
742 | } elsif (/^([^<]+)<(.*)>$/) { |
733 | } elsif (/^([^<]+)<(.*)>$/) { |
743 | push @{ $ext_arg{$1} }, $2; |
734 | push @{ $ext_arg{$1} }, $2; |
744 | |
735 | |
745 | } else { |
736 | } else { |
746 | $ext_arg{$_} ||= []; |
737 | $ext_arg{$_} ||= []; |
747 | } |
|
|
748 | } |
|
|
749 | |
|
|
750 | # now register default key bindings |
|
|
751 | for my $ext (sort keys %ext_arg) { |
|
|
752 | while (my ($k, $v) = each %{ $TERM->{meta}{ext}{$ext}{binding} }) { |
|
|
753 | $TERM->bind_action ($k, "$v->[0]:$v->[1]"); |
|
|
754 | } |
738 | } |
755 | } |
739 | } |
756 | |
740 | |
757 | for my $ext (sort keys %ext_arg) { |
741 | for my $ext (sort keys %ext_arg) { |
758 | my @files = grep -f $_, map "$_/$ext", @dirs; |
742 | my @files = grep -f $_, map "$_/$ext", @dirs; |
… | |
… | |
981 | } |
965 | } |
982 | |
966 | |
983 | bless \%disable, "urxvt::extension::on_disable" |
967 | bless \%disable, "urxvt::extension::on_disable" |
984 | } |
968 | } |
985 | |
969 | |
|
|
970 | =item $self->bind_action ($hotkey, $action) |
|
|
971 | |
986 | =item $self->x_resource ($pattern) |
972 | =item $self->x_resource ($pattern) |
987 | |
973 | |
988 | =item $self->x_resource_boolean ($pattern) |
974 | =item $self->x_resource_boolean ($pattern) |
989 | |
975 | |
990 | These methods support an additional C<%> prefix when called on an |
976 | These methods support an additional C<%> prefix for C<$action> or |
991 | 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 |
992 | C<urxvt::term> class for details. |
979 | methods in the C<urxvt::term> class for details. |
993 | |
980 | |
994 | =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 | } |
995 | |
988 | |
996 | sub x_resource { |
989 | sub x_resource { |
997 | my ($self, $name) = @_; |
990 | my ($self, $name) = @_; |
998 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
991 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
999 | $self->{term}->x_resource ($name) |
992 | $self->{term}->x_resource ($name) |
… | |
… | |
1140 | sub scan_extensions { |
1133 | sub scan_extensions { |
1141 | my ($self) = @_; |
1134 | my ($self) = @_; |
1142 | |
1135 | |
1143 | return if exists $self->{meta}; |
1136 | return if exists $self->{meta}; |
1144 | |
1137 | |
1145 | my @libdirs = perl_libdirs $self; |
1138 | my @urxvtdirs = perl_libdirs $self; |
|
|
1139 | # my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC; |
1146 | |
1140 | |
1147 | # return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d# |
|
|
1148 | |
|
|
1149 | # $self->{meta_libdirs} = join "\x00", @libdirs;#d# |
|
|
1150 | $self->{meta} = \my %meta; |
1141 | $self->{meta} = \my %meta; |
1151 | |
1142 | |
1152 | # first gather extensions |
1143 | # first gather extensions |
1153 | for my $dir (reverse @libdirs) { |
1144 | |
|
|
1145 | my $gather = sub { |
|
|
1146 | my ($dir, $core) = @_; |
|
|
1147 | |
1154 | opendir my $fh, $dir |
1148 | opendir my $fh, $dir |
1155 | or next; |
1149 | or return; |
|
|
1150 | |
1156 | for my $ext (readdir $fh) { |
1151 | for my $ext (readdir $fh) { |
1157 | $ext !~ /^\./ |
1152 | $ext !~ /^\./ |
|
|
1153 | or next; |
|
|
1154 | |
1158 | and open my $fh, "<", "$dir/$ext" |
1155 | open my $fh, "<", "$dir/$ext" |
|
|
1156 | or next; |
|
|
1157 | |
|
|
1158 | -f $fh |
|
|
1159 | or next; |
|
|
1160 | |
|
|
1161 | $ext =~ s/\.uext$// or $core |
1159 | or next; |
1162 | or next; |
1160 | |
1163 | |
1161 | my %ext = (dir => $dir); |
1164 | my %ext = (dir => $dir); |
1162 | |
1165 | |
1163 | while (<$fh>) { |
1166 | while (<$fh>) { |
… | |
… | |
1167 | if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { |
1170 | if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { |
1168 | 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"; |
1169 | } else { |
1172 | } else { |
1170 | $ext{resource}{$pattern} = [$ext, $type, $desc]; |
1173 | $ext{resource}{$pattern} = [$ext, $type, $desc]; |
1171 | } |
1174 | } |
1172 | } elsif (/^#:META:BINDING:(.*)/) { |
|
|
1173 | my ($keysym, $action) = split /:/, $1; |
|
|
1174 | $ext{binding}{$keysym} = [$ext, $action]; |
|
|
1175 | } elsif (/^\s*(?:#|$)/) { |
1175 | } elsif (/^\s*(?:#|$)/) { |
1176 | # skip other comments and empty lines |
1176 | # skip other comments and empty lines |
1177 | } else { |
1177 | } else { |
1178 | last; # stop parsing on first non-empty non-comment line |
1178 | last; # stop parsing on first non-empty non-comment line |
1179 | } |
1179 | } |
1180 | } |
1180 | } |
1181 | |
1181 | |
1182 | $meta{ext}{$ext} = \%ext; |
1182 | $meta{ext}{$ext} = \%ext; |
1183 | } |
1183 | } |
1184 | } |
1184 | }; |
1185 | |
1185 | |
|
|
1186 | # $gather->($_, 0) for @cpandirs; |
|
|
1187 | $gather->($_, 1) for @urxvtdirs; |
|
|
1188 | |
1186 | # and now merge resources and bindings |
1189 | # and now merge resources |
|
|
1190 | |
|
|
1191 | $meta{resource} = \my %resource; |
|
|
1192 | |
1187 | while (my ($k, $v) = each %{ $meta{ext} }) { |
1193 | while (my ($k, $v) = each %{ $meta{ext} }) { |
1188 | #TODO: should check for extensions overriding each other |
1194 | #TODO: should check for extensions overriding each other |
1189 | %{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} }); |
1195 | %resource = (%resource, %{ $v->{resource} }); |
1190 | %{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} }); |
|
|
1191 | } |
1196 | } |
1192 | } |
1197 | } |
1193 | |
1198 | |
1194 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
1199 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
1195 | |
1200 | |
… | |
… | |
1341 | my $res = &x_resource; |
1346 | my $res = &x_resource; |
1342 | |
1347 | |
1343 | $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 |
1344 | } |
1349 | } |
1345 | |
1350 | |
1346 | =item $success = $term->bind_action ($key, $octets) |
1351 | =item $success = $term->bind_action ($key, $action) |
1347 | |
1352 | |
1348 | Adds a key binding exactly as specified via a C<keysym> resource. See the |
1353 | Adds a key binding exactly as specified via a C<keysym> resource. See the |
1349 | C<keysym> resource in the urxvt(1) manpage. |
1354 | C<keysym> resource in the urxvt(1) manpage. |
|
|
1355 | |
|
|
1356 | To add default bindings for actions, an extension should call C<< |
|
|
1357 | ->bind_action >> in its C<init> hook for every such binding. Doing it |
|
|
1358 | in the C<init> hook allows users to override or remove the binding |
|
|
1359 | again. |
|
|
1360 | |
|
|
1361 | Example: the C<searchable-scrollback> by default binds itself |
|
|
1362 | on C<Meta-s>, using C<< $self->bind_action >>, which calls C<< |
|
|
1363 | $term->bind_action >>. |
|
|
1364 | |
|
|
1365 | sub init { |
|
|
1366 | my ($self) = @_; |
|
|
1367 | |
|
|
1368 | $self->bind_action ("M-s" => "%:start"); |
|
|
1369 | } |
1350 | |
1370 | |
1351 | =item $rend = $term->rstyle ([$new_rstyle]) |
1371 | =item $rend = $term->rstyle ([$new_rstyle]) |
1352 | |
1372 | |
1353 | Return and optionally change the current rendition. Text that is output by |
1373 | Return and optionally change the current rendition. Text that is output by |
1354 | the terminal application will use this style. |
1374 | the terminal application will use this style. |
… | |
… | |
1676 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
1696 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
1677 | compare the on-screen display with its stored representation. If they |
1697 | compare the on-screen display with its stored representation. If they |
1678 | differ, it redraws the differences. |
1698 | differ, it redraws the differences. |
1679 | |
1699 | |
1680 | Used after changing terminal contents to display them. |
1700 | Used after changing terminal contents to display them. |
|
|
1701 | |
|
|
1702 | =item $term->refresh_check |
|
|
1703 | |
|
|
1704 | Checks if a refresh has been requested and, if so, schedules one. |
1681 | |
1705 | |
1682 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1706 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1683 | |
1707 | |
1684 | Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> |
1708 | Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> |
1685 | is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost |
1709 | is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost |